diff --git a/.claude/skills/beads-docs/SKILL.md b/.claude/skills/beads-docs/SKILL.md index 52bab8362..a5454d2ea 100644 --- a/.claude/skills/beads-docs/SKILL.md +++ b/.claude/skills/beads-docs/SKILL.md @@ -201,7 +201,8 @@ document what the pinned release does, never main-only features. See ## 9. Verify before you call it done Run the gates in [references/verification.md](references/verification.md). -The short list: `go test ./test/docsync` (nav↔file sync + link conventions), +The short list: `bazel test //test/docsync:docsync_test --config=ci` +(nav↔file sync + link conventions), `./scripts/generate-cli-docs.sh --check` (generated docs fresh), `./scripts/check-doc-freshness.sh` (Last reviewed markers), and a live preview with `make docs-dev` (or `./mint.sh dev`) at `localhost:3000`. diff --git a/.claude/skills/beads-docs/references/simplification.md b/.claude/skills/beads-docs/references/simplification.md index 5152fd2b5..916834ca5 100644 --- a/.claude/skills/beads-docs/references/simplification.md +++ b/.claude/skills/beads-docs/references/simplification.md @@ -39,8 +39,9 @@ don't measure that work by the word delta. *not* simplifying — it buries the real change in the diff. 4. **Loss-check** (below). 5. **Fact-check** (below). -6. **Gates:** `go test ./test/docsync`, every fence parses, no body H1, no - HTML comments (MDX), preview with `make docs-dev`. +6. **Gates:** `bazel test //test/docsync:docsync_test --config=ci`, every + fence parses, no body H1, no HTML comments (MDX), preview with + `make docs-dev`. 7. **Preview, then commit on approval** — one page or section per batch, so the reviewer can steer before a cut compounds across the section. diff --git a/.claude/skills/beads-docs/references/verification.md b/.claude/skills/beads-docs/references/verification.md index 559bfb6f3..44aabca76 100644 --- a/.claude/skills/beads-docs/references/verification.md +++ b/.claude/skills/beads-docs/references/verification.md @@ -8,7 +8,7 @@ Run these before considering docs work complete. Ordered cheapest-first. # 1. Docs sync: docs.json nav <-> file consistency, link conventions # (root-relative extensionless in docs/, exact paths in engdocs/ and # curated root files), orphan detection (only CLI_REFERENCE.md is exempt). -go test ./test/docsync +bazel test //test/docsync:docsync_test --config=ci # 2. Generated CLI docs freshness: regenerates from the live command tree # and diffs docs/CLI_REFERENCE.md, docs/cli-reference/, and the CLI diff --git a/.github/scripts/embedded-cmd-test-shards.txt b/.github/scripts/embedded-cmd-test-shards.txt index ce1179ad6..21e6f181d 100644 --- a/.github/scripts/embedded-cmd-test-shards.txt +++ b/.github/scripts/embedded-cmd-test-shards.txt @@ -11,7 +11,7 @@ # t.Parallel) add up, parallel ones share -test.parallel=4. # Regenerate with scripts/ci/gen_embedded_cmd_shard_manifest.py 100 # --weights=duration --write after adding, splitting or removing -# TestEmbedded* functions in cmd/bd/*_embedded_test.go. --write is +# TestEmbedded* functions in cmd/bd/*_test.go. --write is # incremental: it keeps every already-assigned test on its current shard # and only places newly-discovered names, onto whichever shard is # currently lightest, so two unrelated PRs that each add one test do not @@ -59,101 +59,206 @@ 100 17 TestEmbeddedReopen 100 18 TestEmbeddedLabelPropagateRename +100 18 TestEmbeddedPrune_protectsBeadCitedByCustomStatusBead 100 19 TestEmbeddedLabelConcurrent +100 19 TestEmbeddedNewDoltStore_StrictReadOnlyRefusesWritesOnFreshDatabase 100 20 TestEmbeddedInitRoleRoutingRetainedFork +100 20 TestEmbeddedMigrateSchema_IdentityMismatchRefusesBeforeApplying 100 21 TestEmbeddedMaxRowsReady +100 21 TestEmbeddedMigratePersonal_movesIssues 100 22 TestEmbeddedCount +100 22 TestEmbeddedIfRevisionCloseReplaysMoleculeAutoClose 100 23 TestEmbeddedCountConcurrent +100 23 TestEmbeddedExportExcludeOwner_flag +100 24 TestEmbeddedEventsTailFollowReportsTruncationOnTheStream 100 24 TestEmbeddedUndeferConcurrent +100 24 TestEmbeddedWispGCProtectsActiveWisps +100 25 TestEmbeddedDoltRemoteAdd_LocalOnly_FiresBeforeGuard 100 25 TestEmbeddedMaxRowsListBasic +100 25 TestEmbeddedRemovedBackendHealRejectionPerBackend +100 26 TestEmbeddedDoltRemoteAdd_JSON_AllowGitOrigin_WarningOnStderr 100 26 TestEmbeddedExternalMutationPolicy +100 26 TestEmbeddedPersistentPreRunLogsAndSkipsIdentityCheckForFreshEmbeddedWorkspace +100 27 TestEmbeddedDoltRemoteAdd_GitOriginCollision_RefusalMessageCopy +100 27 TestEmbeddedNewDoltStoreFromConfig_DottedDBName 100 27 TestEmbeddedShipConcurrent +100 28 TestEmbeddedDoltLocalOnly_RemoteAdd_RefusesExitOne 100 28 TestEmbeddedHistoryConcurrent +100 28 TestEmbeddedImportChunkedRealStoreResumeConverges +100 29 TestEmbeddedDoltLocalOnly_RemoteAdd_ErrorOnStderr 100 29 TestEmbeddedEpicCloseEligibleReasonFlag +100 29 TestEmbeddedImportChunkedNoReadyWindowWithReadinessEdgeIntoCycle 100 30 TestEmbeddedCloseGuardsAndEpics +100 30 TestEmbeddedDoltLocalOnly_Push_ExitsZeroWithMessage +100 30 TestEmbeddedImportChunkedCrossBucketBlocksEdgesResumeBackfills +100 31 TestEmbeddedDoltLocalOnly_ConfigRoundTrip +100 31 TestEmbeddedIfRevisionCloseWarnsOnForcedOpenChildren 100 31 TestEmbeddedInitSelectedExcludeRoutingForkInvalidQuiet +100 32 TestEmbeddedDoctorUnsupportedJSON +100 32 TestEmbeddedIfRevisionAdvertisedOnFourVerbs 100 32 TestEmbeddedListSearchAndOutputFormats 100 33 TestEmbeddedBootstrapJSONLAndGitOrigin +100 33 TestEmbeddedDeleteJournalsTheRequestingActor +100 33 TestEmbeddedExportExcludeOwner_verbose +100 34 TestEmbeddedCopyIssueRelations_preservesCommentWithTimestamp +100 34 TestEmbeddedEventsTailReportsTruncationToTheCLI 100 34 TestEmbeddedUnclaimBatchAndRefusals +100 34 TestEmbeddedWispGCPurgeClosedDoesNotCascadeIntoLiveSteps +100 35 TestEmbeddedAutoPruneRespectsBdConfigSet +100 35 TestEmbeddedEventsReadNoticesADisabledJournal 100 35 TestEmbeddedGateCreateBeadRename +100 35 TestEmbeddedVersionedHistoryEnvIsProcessWideAndOnlyTurnsRecordingOn +100 36 TestEmbeddedAutoPruneLeavesAnUnboundedJournalAlone +100 36 TestEmbeddedDoltRemoteResetData_UnknownRemote 100 36 TestEmbeddedGateConcurrent +100 36 TestEmbeddedUnclaimIfAssigneeCLIDifferentSpelling +100 37 TestEmbeddedAutoPruneBoundsTheJournalAfterAMutatingCommand +100 37 TestEmbeddedDoltRemoteResetData_CloudRemoteRefused 100 37 TestEmbeddedMaxRowsDepTreeAndDuplicates +100 37 TestEmbeddedSpawnMolecule_SubstitutesTemplatedStepFields 100 38 TestEmbeddedGraphConcurrent +100 38 TestEmbeddedRoutedCreateJournalsIntoTheTargetWorkspace +100 38 TestEmbeddedUnclaimIfAssigneeFlagValidation +100 39 TestEmbeddedIfRevisionRejectsLabelAndParentEdits 100 39 TestEmbeddedMaxRowsGraph +100 39 TestEmbeddedNewDoltStoreFromConfig_NoMetadata +100 40 TestEmbeddedIfRevisionOutranksReassignFenceCLI +100 40 TestEmbeddedNewDoltStoreFromConfig_HyphenatedDBName 100 40 TestEmbeddedUpdateLifecycleClaimParentCommit 100 41 TestEmbeddedDuplicateConcurrent +100 41 TestEmbeddedVersionedHistoryFollowsTheStoreItWritesInto 100 42 TestEmbeddedInitAForkAutoContributor +100 42 TestEmbeddedUpdateIfGuardsFlagValidation +100 43 TestEmbeddedIfRevisionMultiIDRejected 100 43 TestEmbeddedInitExplicitBeadsDirIsAuthoritative +100 44 TestEmbeddedIfRevisionComposesWithIfAssigneeIfStatus 100 44 TestEmbeddedStaleConcurrent 100 45 TestEmbeddedGraph +100 45 TestEmbeddedUpdateIfGuardsCLI 100 46 TestEmbeddedCloseAlreadyClosedClaimNextAndMolecule +100 46 TestEmbeddedIfRevisionMatchAndMismatch 100 47 TestEmbeddedListSearchAndOutputSearchAndSort +100 47 TestEmbeddedRevisionRemintMatrix 100 48 TestEmbeddedDeferConcurrent +100 48 TestEmbeddedReassignFenceCLI +100 49 TestEmbeddedBackupRestoreStrictReadonly 100 49 TestEmbeddedInitAPushConsentAndRemoteBootstrap +100 49 TestEmbeddedMigratePersonal_abortOnNoConfirm 100 50 TestEmbeddedDiffConcurrent +100 50 TestEmbeddedDoltRemoteAdd_AllowGitOrigin_WarningOnStderr +100 50 TestEmbeddedImportChunkedWaitsForChildImportedLaterStaysBlocked +100 50 TestEmbeddedVersionOutputShape +100 51 TestEmbeddedDoltRemoteAdd_AllowGitOrigin_Exits0 +100 51 TestEmbeddedHistoryAndShowAsOfReadDoltCommits +100 51 TestEmbeddedImportChunkedStaleRejectedRowKeepsDeferredDepsOut 100 51 TestEmbeddedInitGitBootstrapRoutingFreshQuiet +100 52 TestEmbeddedConfigSetOtherKeysSkipTheVersionedHistoryScan +100 52 TestEmbeddedDoltLocalOnly_Push_LocalStoreCopy +100 52 TestEmbeddedImportChunkedNoReadyWindowAtAnyFreezePoint 100 52 TestEmbeddedSwarmConcurrent +100 53 TestEmbeddedDoltLocalOnly_Push_JSON_DisabledStatus +100 53 TestEmbeddedIfRevisionOrdinaryCAS +100 53 TestEmbeddedImportChunkedMixedRegularWispCrossBucketEdgesWired 100 53 TestEmbeddedInitSelectedExcludeRoutingStealthDecoyQuiet +100 54 TestEmbeddedDiscoveryPinsEnvFileReadonly +100 54 TestEmbeddedFormatJSONAliasMatchesJSON +100 54 TestEmbeddedGraphModeDependencyWorkspaceUnaffected +100 54 TestEmbeddedInitAgentArtifactsGolden 100 54 TestEmbeddedSearchConcurrent +100 54 TestEmbeddedShowAsOfFailureExitCodes +100 55 TestEmbeddedDoltLocalOnly_Pull_JSON_DisabledStatus +100 55 TestEmbeddedImportChunkedConcurrentUpdateKeepsDeferredDeps 100 55 TestEmbeddedUndefer +100 55 TestEmbeddedVersionedHistorySwitchScansEveryRowNotOnePage 100 56 TestEmbeddedDepNoCycleCheck +100 56 TestEmbeddedDoltLocalOnly_Pull_ExitsZeroWithMessage +100 56 TestEmbeddedImportChunkedConcurrentUpdateKeepsBlockingDeps +100 56 TestEmbeddedVersionedHistorySwitchRoundTrip +100 57 TestEmbeddedDoltLocalOnly_DoltStatus_ShowsDisabled +100 57 TestEmbeddedIfRevisionDeletePreflightGoneIsPreconditionFailed 100 57 TestEmbeddedQueryConcurrent +100 57 TestEmbeddedVersionedHistorySwitchRefusesUnversionableMetadata 100 58 TestEmbeddedDepAAddRejectionsAndBulk +100 58 TestEmbeddedDoctorUnsupportedProse +100 58 TestEmbeddedIfRevisionCascadeDelete +100 58 TestEmbeddedVersionedHistorySwitchRefusesAnUnrecordableGateTimeout 100 59 TestEmbeddedDeferAutoWake +100 59 TestEmbeddedDoctorSupportedChecks +100 59 TestEmbeddedIdentityGateRendersSchemaSkewFromForwardDriftedWorkspace +100 59 TestEmbeddedVersionedHistorySetManyRefusesUnversionableMetadata 100 60 TestEmbeddedCommentsCLI +100 60 TestEmbeddedCorruptMetadataFailsLoudUntilRestored +100 60 TestEmbeddedExportExcludeOwner_config +100 60 TestEmbeddedRoutedWriteMissDoesNotCreateTargetDatabase +100 60 TestEmbeddedWispGCPurgeClosedStillPurgesFullyClosedMolecules +100 61 TestEmbeddedBootstrapCloneFailureScrubsCredentials +100 61 TestEmbeddedContributorRoutedWritesCommitInPlanning +100 61 TestEmbeddedEventsPruneHonorsRetainRowsFloorFromConfig 100 61 TestEmbeddedUpdateRoutedStoreCommitsTargetHead +100 61 TestEmbeddedVersionedHistoryConfigSetWritesTheStoreRow +100 62 TestEmbeddedAutoPruneDoesNotRunForReadOnlyCommands +100 62 TestEmbeddedDoltRemoteResetData_GitBacked +100 62 TestEmbeddedGateCheckSkipsTemplateGates 100 62 TestEmbeddedReadyBlockersAndLabels +100 62 TestEmbeddedUnclaimIfAssigneeCLI 100 63 TestEmbeddedDepAndLinkBatchAutoCommitDoesNotAdvanceHead +100 63 TestEmbeddedGateCheckLimitCountsOnlyLiveGates +100 63 TestEmbeddedIfRevisionDeletePreflightGoneParentIsPreconditionFailed +100 63 TestEmbeddedListPageEdges +100 64 TestEmbeddedAutoExportExcludeOwner_config +100 64 TestEmbeddedDoltRemoteAdd_NoGitOrigin_ProceedsNormally 100 64 TestEmbeddedGateWaiterCheckLifecycle 100 64 TestEmbeddedPromoteMovesAWispParent +100 64 TestEmbeddedSpawnMolecule_PreservesStepLabels 100 65 TestEmbeddedIfRevisionPreflightGoneIsPreconditionFailedOnEveryVerb +100 65 TestEmbeddedRemovedBackendHealRoundTrip 100 65 TestEmbeddedSupersede 100 66 TestEmbeddedCloseBasicIsolatedStores @@ -218,6 +323,7 @@ 100 71 TestEmbeddedCloseJSONReportsMoleculeAutoClose 100 71 TestEmbeddedInitRoleRoutingExplicitDefault 100 71 TestEmbeddedPrimeChangeDirRedirectNoticeFollowsTarget +100 71 TestEmbeddedRoutedCreateHonorsTheEnvOverrideOverTheTargetsConfig 100 71 TestEmbeddedSearchRoutesAgree 100 72 TestEmbeddedContributorCreateMultiple @@ -328,8 +434,10 @@ 100 83 TestEmbeddedPurgeFiltered 100 83 TestEmbeddedReadyConcurrent +100 84 TestEmbeddedDoltRemoteAdd_GitOriginCollision_Exits1 100 84 TestEmbeddedInitGitBootstrapRoutingDecoyInvalid 100 84 TestEmbeddedInitSelectedExcludeRoutingStealthInvalid +100 84 TestEmbeddedMigratePersonal_preservesComments 100 85 TestEmbeddedBootstrapExistingDryRunInit 100 85 TestEmbeddedChildrenBasicAndEmpty @@ -338,8 +446,10 @@ 100 85 TestEmbeddedIfRevisionReopenGuardDirect 100 85 TestEmbeddedInitArtifactRouting +100 86 TestEmbeddedDoltRemoteAdd_DifferentURL_ProceedsNormally 100 86 TestEmbeddedExplicitHierarchicalParentEdges 100 86 TestEmbeddedInitHooksRouting +100 86 TestEmbeddedMigratePersonal_noopWhenEmpty 100 87 TestEmbeddedCreateRepoProxiedTargetError 100 87 TestEmbeddedGateInheritsDownParentChain diff --git a/.github/scripts/embedded-storage-test-shards.txt b/.github/scripts/embedded-storage-test-shards.txt index 4401f3cfe..c3f45aacb 100644 --- a/.github/scripts/embedded-storage-test-shards.txt +++ b/.github/scripts/embedded-storage-test-shards.txt @@ -176,14 +176,17 @@ 40 3 TestTransactionCleanupBeforeSQLCommitRemainsDefinite 40 3 TestUnknownProvenanceLeaseStaysReclaimable +40 4 TestBlockedListerContract 40 4 TestCreateBatchFastPathsMatchPerRowSmallDepAdd_Embedded 40 4 TestEmbeddedIssueOperationsUpdateLabelPatchOrdering 40 4 TestEmbeddedReaderGetMissIsNotFoundAndBackendFailureDoesNotDecay +40 4 TestEmbeddedReaderListFilterFamiliesNarrowToTheirRows 40 4 TestMergeAndSettleWithStrategy_EmptyStrategyMatchesMergeAndSettle 40 5 TestEmbeddedClaimerRefusesIncompleteRequestsAndAnAbsentIDWithoutTouchingState 40 5 TestEmbeddedIssueOperationsCloseAndReopenAWisp 40 5 TestEmbeddedReaderListKeysetPositionResumesTheCreatedDescIDAscOrder +40 5 TestRecordVersionKeepsSubSecondChangeAt 40 5 TestWithPeerAuth 40 6 TestCreateBatchFastPathsMatchPerRowApplyWaitsFor_Embedded @@ -193,6 +196,7 @@ 40 6 TestEmbeddedRelationsAnswersAWispTargetInTheOutDirection 40 6 TestPromoteStillWorksWithCollisionGuard 40 6 TestSearchWithMissingWispPlaneTables +40 6 TestVersionedHistoryKeepsNumbersTheStoreDistinguishesApart 40 7 TestConcurrencyMultiProcess 40 7 TestEmbeddedBatchCloserRecordsOneHistoryEntryForWhatLanded @@ -201,17 +205,20 @@ 40 7 TestEmbeddedIssueOperationsUpdateMetadataReplaceClearsAndValidates 40 7 TestEmbeddedLenientOpenWarning_DataBehind 40 7 TestEmbeddedRelationsLeavesTheCallersRequestAlone +40 7 TestLoseVersionLeavesTheEpochTablesCommitted 40 7 TestMergeAndSettleWithStrategy_ResolvesDeclinedConflict 40 8 TestDeleterContract 40 8 TestEmbeddedDependencyEditorRoutesWispSourcedRemovalToTheWispPlane 40 8 TestEmbeddedMergeAndSettleDirtyWorkingSetSurvivesRefusedMerge +40 8 TestEmbeddedMintLeavesUpdatedAtWhereHistoryOffDoes 40 8 TestEmbeddedReaderGetBriefDepsProjectsTheDependencyRows 40 8 TestEmbeddedRelationsOrdersNeighborsFromBothPlanesTogether 40 8 TestEmbeddedReopenIssueCategorySemantics 40 8 TestGetIssueCommentsPageEmbedded 40 8 TestListWisps +40 9 TestBumpEpochCarryingNeitherCarriesNorServesARowFromAFutureEpoch 40 9 TestEmbeddedDependencyEditorRefusesCrossPlaneCycle 40 9 TestEmbeddedDependencyEditorSameTypeReAddIsIdempotent 40 9 TestEmbeddedDependencyEditorSnapshotsTheRequest @@ -230,8 +237,10 @@ 40 10 TestGraphCounterContract 40 10 TestIgnoredCursorHealRespectsOperatorOverride 40 10 TestRunInTransactionPostCommitStageFailureIsIndeterminate +40 10 TestVersionedHistoryOffMatchesPreStackGolden_Embedded 40 10 TestWithPeerAuth_WarnsWhenStoredPeerSuppressesAmbientPasswordAmbient +40 11 TestABumpUnderOneStoreIDMovesTheEpochSeenThroughEveryStoreID 40 11 TestEmbeddedBatchCreateFirstVersionCarriesCreationTimeEdges 40 11 TestEmbeddedClaimerRefusalMessagesCarryTheirFragments 40 11 TestEmbeddedGuardedUpdateMintsOnceAfterItsPatches @@ -251,6 +260,7 @@ 40 12 TestEmbeddedReadyClaimerAnswersTheQuestionReaderReadyLists 40 12 TestHistoryPresenceContract 40 12 TestLifecycleUpdateContract +40 12 TestReaderListExcludeStatusAcceptsAWorkspaceCustomStatus 40 13 TestEmbeddedDepRekeyConvergesRenameChain 40 13 TestEmbeddedDependencyEditorAppliesParentChildBeforeBlockingEdges @@ -271,6 +281,7 @@ 40 14 TestEmbeddedReaderReadyDefaultTypeExclusionsYieldToAnExplicitType 40 14 TestEmbeddedReadyClaimerClaimsTheFrontRowAndReturnsThePostClaimState 40 14 TestEmbeddedReadyClaimerDoesNotMutateTheCallerRequest +40 14 TestHeartbeatIssueCommitsARefusalOnlyWhenItReadTheIssueEmbedded 40 14 TestHistory_NullTextColumns 40 15 TestCreateIssuesRejectStaleUpserts @@ -307,6 +318,7 @@ 40 17 TestStatsReporterContract 40 17 TestVersionReconcilerContract +40 18 TestCreateBatchParticipationGeneration 40 18 TestEmbeddedBatchCloserIdempotentRecloseIsAPerItemSuccess 40 18 TestEmbeddedDependencyEditorMixedBatchWritesBothPlanes 40 18 TestEmbeddedIssueOperationsUpdateRawMetadataTakesTheFunnelsValueShapes @@ -326,9 +338,11 @@ 40 19 TestIgnoredCursorHealConvergesFromEveryCrashState 40 19 TestOpenAfterCloseCreatesNewStore 40 19 TestOpenReturnsCachedStore +40 19 TestParticipationGenerationFixtureKitIsWired 40 19 TestRemoteVerbsPresentStoredPeerCredentials 40 19 TestRenameLabelMintsOneVersionPerTouchedBead +40 20 TestBumpEpochCarryingCarriesOnlyTheLineageHoldingTheNewestRow 40 20 TestCreateIssue 40 20 TestEmbeddedCheckedWrappersRouteTheirPreconditions 40 20 TestEmbeddedIssueOperationsCreateRoutesInfraTypesToWisps @@ -340,6 +354,7 @@ 40 20 TestHeartbeatRejectsWispEmbedded 40 20 TestIgnoredCursorHealNeverResurrectsRolledBackVersions +40 21 TestBumpEpochCarryingCarriesTheLiveRowsOfEveryStoreInTheDatabase 40 21 TestCreateRejectsCrossTableIDCollision 40 21 TestEmbeddedBatchCloserItemsAnswerToTheCloseGuards 40 21 TestEmbeddedDependencyEditorAcceptsATypeOutsideTheConstants @@ -363,6 +378,7 @@ 40 22 TestLeaseLifecycleEmbedded 40 22 TestPolicyBlockingAnnotatorForeignOpensAreSublinear +40 23 TestAsOfReadContract 40 23 TestEmbeddedBatchCloserBackendFailureReturnsNoOutcomes 40 23 TestEmbeddedBatchCloserClaimNextHydratesWhenSomethingClosed 40 23 TestEmbeddedDependencyEditorAcceptsBlockingAcrossIssueTypes @@ -388,12 +404,14 @@ 40 24 TestReopenIssue 40 25 TestBatchGetterContract +40 25 TestDatabases 40 25 TestDualWriteFixtureKitIsWired 40 25 TestEmbeddedBatchCloserClaimNextIsNilWhenNothingClosed 40 25 TestEmbeddedIssueOperationsUpdateClaimHonorsConfiguredActiveStatuses 40 25 TestEmbeddedReadyClaimerLeavesEphemeralRowsOutOfTheDefaultReadySet 40 25 TestEmbeddedReadyClaimerRejectsLimitOffsetBriefAndEmptyActor 40 25 TestGetDependentRecordsForIssuesEmbedded +40 25 TestHeartbeaterContract 40 25 TestIgnoredCursorHealIsIdempotent 40 25 TestIsBlockedBatchEmbedded 40 25 TestReadyWorkPageTotal @@ -423,6 +441,7 @@ 40 27 TestRemoteGitDataRefOnEngine 40 27 TestSweeperContract +40 28 TestBumpEpochCarryingDoesNotCarryALostLineage 40 28 TestEmbeddedBatchCloserForceBypassesOnlyClosePolicy 40 28 TestEmbeddedBatchCloserSettlesTheDependersOfWhatItClosed 40 28 TestEmbeddedClaimerClaimsAnUnassignedOpenIssueAndAnswersTheBareRow @@ -441,6 +460,7 @@ 40 29 TestEmbeddedDependencyEditorRecordsOneHistoryEntryPerLandedRequest 40 29 TestEmbeddedMergeAndSettleMetadataConflict 40 29 TestEmbeddedReaderListDefaultExclusionsAndTheirOverrides +40 29 TestEmbeddedReaderListTimeBoundsAreStrictAndWholeSecond 40 29 TestEmbeddedReaderReadySetOwnsItsStatusPinnedAndTemplateDecisions 40 29 TestEmbeddedTransactionSameStatusDoesNotPublishUnrelatedDurableChanges 40 29 TestEventsJournalAccessor @@ -459,6 +479,7 @@ 40 30 TestLegacyTrackedIgnoredCursorUnwedgesPull 40 30 TestUpdateMergeOps_DoltEngine_TwoIssues +40 31 TestBumpEpochCarryingWritesOneCarryRowPerLiveIDNamingTheLineageRoot 40 31 TestDualWriteContract 40 31 TestEmbeddedDependencyEditorAcceptsAForeignRepoTarget 40 31 TestEmbeddedDependencyEditorMaintainsBlockedStateAcrossPlanes @@ -471,6 +492,7 @@ 40 31 TestReadyCounterContract 40 31 TestWithPeerAuth_KeyMismatchFailsClosed +40 32 TestCurrentAddressForNeverReseedsAnAbsentStoreEpochRow 40 32 TestEmbeddedClaimerGrantsALiveLeaseOnTheRowItWonAndLeavesARefusedOneAlone 40 32 TestEmbeddedDependencyEditorRefusesAMissingLocalTarget 40 32 TestEmbeddedDirtyTablesGate_BlocksReopenThenWorkingSetReconcileRecovers @@ -491,11 +513,13 @@ 40 33 TestEmbeddedRelationsResolvesTheAnchorIDExactly 40 33 TestEmbeddedSyncCommitsConfigBeforeMerge 40 33 TestEventsAutoPruneThrottleSkipsTheSecondPass +40 33 TestFirstMintLeavesTheEpochTablesCommitted 40 33 TestGetDependentRecordsEmbedded 40 33 TestPruneEventsBatchDeletesTheLowestSeqsOnly 40 33 TestTreeWalkerContract 40 34 TestAddLabel +40 34 TestBumpEpochCarryingLeavesTheEpochTablesCommitted 40 34 TestDecryptPassword_KeyMismatchNamesTheLocalKey 40 34 TestEmbeddedBlockedRecheckRecordsUnblockingWrites 40 34 TestEmbeddedDependencyEditorAttributesItsEventsToTheActor @@ -519,6 +543,7 @@ 40 35 TestReadyWorkWithMissingDeferredParentTables 40 35 TestReclaimExpiredLeaseSurvivesRestartEmbedded +40 36 TestBumpEpochCarryingFailsAndRollsBackWhenARowAlreadyExistsAtTheNewEpoch 40 36 TestCommenterContract 40 36 TestConcurrentOpenReturnsCached 40 36 TestEmbeddedBatchCloserAllRefusedBatchRecordsNoHistory @@ -541,6 +566,7 @@ 40 37 TestEmbeddedMergeAndSettleReportsOperatorConflicts 40 37 TestEmbeddedReaderListBriefDropsTheFreeFormTextAndNothingElse 40 37 TestEmbeddedReaderListNaturalNumericIDSortTrimsAfterTheFetch +40 37 TestEpochWritesReportAnUnpublishedCommitAsIndeterminate 40 37 TestIgnoredCursorHealRespectsOverrideUnderBroaderPattern 40 38 TestCreateIssues @@ -564,6 +590,7 @@ 40 39 TestEmbeddedMigrateRepairedDependenciesIDColumnCommitsAtomicallyWithVersion53_4690 40 39 TestEmbeddedReaderListSkipCountsDropsTheCardinalitiesAndNothingElse 40 39 TestEmbeddedRelationsResolvesAWispAnchor +40 39 TestParticipationGenerationFence 40 39 TestPreviewStoreRefusesLocalMetadataWrite 40 39 TestReclaimRefusesForeignReplicaLease 40 39 TestWorkspaceConfigContract diff --git a/.github/scripts/embedded-test-shard.sh b/.github/scripts/embedded-test-shard.sh index a89757e69..3b7bdc7e2 100755 --- a/.github/scripts/embedded-test-shard.sh +++ b/.github/scripts/embedded-test-shard.sh @@ -3,7 +3,7 @@ # # Usage: embedded-test-shard.sh # -# Discovers all TestEmbedded* top-level functions from cmd/bd/*_embedded_test.go. +# Discovers all TestEmbedded* top-level functions in cmd/bd/*_test.go. # Tests listed in embedded-cmd-test-shards.txt for the requested shard count use # that committed assignment; newly-added tests fall back to hash(name) % total. # Runs the matching subset using the pre-built test binary at @@ -33,8 +33,12 @@ fi SHARD_INDEX=$(( SHARD_NUMBER - 1 )) MANIFEST="${BEADS_TEST_SHARD_MANIFEST:-.github/scripts/embedded-cmd-test-shards.txt}" -# Discover all top-level TestEmbedded* functions. -ALL_TESTS=$(grep -rh '^func TestEmbedded' cmd/bd/*_embedded_test.go \ +# Discover all top-level TestEmbedded* functions across every cmd/bd test +# file, by name rather than by file glob (as proxied-test-shard.sh does): a +# test gated on BEADS_TEST_EMBEDDED_DOLT runs in this lane or in none, wherever +# it lives. scripts/embedded_lane_coverage_test.go fails on a gated test this +# selection misses. +ALL_TESTS=$(grep -rh '^func TestEmbedded' cmd/bd/*_test.go \ | sed 's/func \(TestEmbedded[A-Za-z0-9_]*\).*/\1/' \ | sort -u) diff --git a/.github/scripts/proxied-cmd-test-shards.txt b/.github/scripts/proxied-cmd-test-shards.txt index 33611719b..fca167226 100644 --- a/.github/scripts/proxied-cmd-test-shards.txt +++ b/.github/scripts/proxied-cmd-test-shards.txt @@ -69,6 +69,7 @@ 34 6 TestProxiedServerServeReadsTheJournalItJustWrote 34 6 TestProxiedServerSwarm 34 6 TestProxiedServerUpdate2B +34 6 TestProxiedServerVersionedHistorySwitchRefusesAnUnrecordableGateTimeout 34 6 TestProxiedServerWispList 34 7 TestProxiedServerCloseConcurrent @@ -156,6 +157,7 @@ 34 17 TestProxiedServerPrime 34 17 TestProxiedServerSQLDatabaseFlag 34 17 TestProxiedServerServeModeGate +34 17 TestServerModeServeIgnoresGraphModeDependency 34 18 TestProxiedServerClose3 34 18 TestProxiedServerCount @@ -254,11 +256,13 @@ 34 30 TestProxiedServerStatus 34 30 TestProxiedServerTodo 34 30 TestProxiedServerUpdate2 +34 30 TestProxiedServerVersionedHistoryServeActivatesTheProviderFromItsOwnRow 34 31 TestProxiedServerCloseBeadGate 34 31 TestProxiedServerComment 34 31 TestProxiedServerConfigB 34 31 TestProxiedServerEventsJournal +34 31 TestProxiedServerGateAddWaiterConvoy 34 31 TestProxiedServerIfRevisionGuardClose 34 31 TestProxiedServerMolBond diff --git a/.github/workflows/bazel.yml b/.github/workflows/bazel.yml index 03a769e7f..b319ab300 100644 --- a/.github/workflows/bazel.yml +++ b/.github/workflows/bazel.yml @@ -1085,7 +1085,7 @@ jobs: outputs: result: ${{ steps.result.outputs.result }} env: - PURE_CMD_BD_TESTS: '^Test(Help|CheckRemoteSafety|FormatDestroyToken|ShouldWireInitRemote|ExtractPrefix|IsNumericID|GetWorktreeGitDir|DriftItemStatuses|RunDriftChecks|IsServerProbablyRunning|CheckHooksDriftNotGitRepo|CheckServerDriftNoBeadsDir|CheckRemoteDriftNoBeadsDir|NocgoFactoriesHonorSharedServer|NocgoNewDoltStoreFromConfig_ErrorSuggestsCorrectFlag|NocgoNewReadOnlyStoreFromConfig_ErrorSuggestsCorrectFlag)' + PURE_CMD_BD_TESTS: '^Test(Help|CheckRemoteSafety|FormatDestroyToken|ShouldWireInitRemote|ExtractPrefix|IsNumericID|GetWorktreeGitDir|DriftItemStatuses|RunDriftChecks|IsServerProbablyRunning|CheckHooksDriftNotGitRepo|CheckServerDriftNoBeadsDir|CheckRemoteDriftNoBeadsDir|NocgoFactoriesHonorSharedServer|NocgoNewDoltStoreFromConfig_ErrorSuggestsCorrectFlag|NocgoNewReadOnlyStoreFromConfig_ErrorSuggestsCorrectFlag|NocgoStoreFactoriesRefuseGraphWorkspace)' # The only pre-merge run of these boundaries: where it executes # remotely --config=sole-run fails on a remote cache eviction instead # of re-running the whole invocation (whose retry could turn a failed diff --git a/.golangci.yml b/.golangci.yml index 9e1cf64a3..1ed2975a4 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -471,7 +471,13 @@ linters: # `search` LEFT this list when all three of its routes moved onto # issueops.Reader.List with issueops.SearchListRequest (cmd/bd/search.go); # it builds no filter any more. - - path: '^cmd/bd/(close|duplicates|find_duplicates|gate|gc|graph|info|label|orphans|purge|todo|wisp|human)(_proxied_server)?\.go$' + # + # `gate` LEFT it when `bd gate check` joined `bd gate list` on + # issueops.ListGates over the route's Querier: cmd/bd/gate.go and + # cmd/bd/gate_proxied_server.go name no filter type any more. + # `gate_discover` keeps its own hole below, since findPendingGates still + # asks SearchIssues for its gates. + - path: '^cmd/bd/(close|duplicates|find_duplicates|gc|graph|info|label|orphans|purge|todo|wisp|human)(_proxied_server)?\.go$' text: 'do not write a filter here' linters: - forbidigo diff --git a/AGENTS.md b/AGENTS.md index 1a450309e..e908a5070 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -126,9 +126,29 @@ make install # build and install bd to ~/.local/bin (canonical) certificate `--config=remote-exec`, agent hosts whose `~/.bazelrc` names the executor neither. Make yours the default with a `build --config=...` line in the gitignored `.bazelrc.local`, or pass `BAZEL_FLAGS=...` to make. -- `go test` (`./scripts/test.sh`, `make test-go`) is an inner-loop - convenience only. CI does not enforce it, and it skips nogo, gofmt and the - guards; finish with `make test`. +- Agents run tests only with `bazel test`, also while iterating on one + behavior: + + ```bash + bazel test //cmd/bd:bd_test --config=ci --test_filter='^TestName$' --test_output=all + ``` + + A target also passes when the test never ran (a filter that matches + nothing, a skip, a file the configuration does not compile), so count a run + only when its log shows `--- PASS: TestName` and no `--- SKIP` for the test + or a `TestName/...` subtest: Go prints `--- PASS` for a test whose every + subtest skipped. "Check That the Test Ran" in + [engdocs/TESTING.md](engdocs/TESTING.md) names the tests `--config=ci` does + not run (Dolt-backed, `-short`-gated, integration-tagged, `TestEmbedded*` + and embedded-Dolt, files `BUILD.bazel` does not list) and the way into + each. An unchanged target returns its cached result, which is the same + evidence. Finish with `make test`. +- Agents do not run `go test` (`./scripts/test.sh`, `make test-go`): CI does + not enforce it, it skips nogo, gofmt and the guards, and agent hosts may + refuse it. It stays a convenience for humans working offline. The exception + is regenerating golden files (`make corpus-regen`, `make githooks-regen`, + `BD_UPDATE_GOLDEN=1`), which Bazel cannot do: see "Regenerating Golden + Files" in [engdocs/TESTING.md](engdocs/TESTING.md). - **Do NOT** use `go build -o bd ./cmd/bd`, `go install ./cmd/bd`, or raw `go run ./cmd/bd ...`: they bypass the canonical build path, leave stale binaries, and raw `go run` misses the `gms_pure_go` tag. Use `make install`, diff --git a/BUILD.bazel b/BUILD.bazel index 7b10becbc..0a1d10355 100644 --- a/BUILD.bazel +++ b/BUILD.bazel @@ -74,6 +74,13 @@ exports_files( visibility = ["//scripts:__pkg__"], ) +# //scripts:shell_scripts_test: Oracle A's runner, whose EXIT-trap removal of +# its reference worktree oracle_a_script_test.go checks in a fixture repository. +exports_files( + ["tests/oracle-a/run-oracle-a.sh"], + visibility = ["//scripts:__pkg__"], +) + # The nested Go modules' go.mod files, which mark where the root module ends: # //scripts:go_test_sources_test's scan of every _test.go file skips their # trees, as `go test ./...` does. (go.mod is in no Go partition below: it is @@ -246,6 +253,20 @@ exports_files( visibility = ["//internal/httpclient/encode:__pkg__"], ) +# --- begin go_srcs (managed by tools/bazel/go_srcs.py; run `make bazel-sync`) --- + +filegroup( + name = "go_srcs", + srcs = glob( + ["**/*.go"], + allow_empty = True, + exclude = ["bazel-*/**"], + ), + visibility = ["//:__subpackages__"], +) + +# --- end go_srcs --- + # --- begin repo_files (managed by tools/bazel/go_srcs.py; run `make bazel-sync`) --- filegroup( @@ -344,6 +365,7 @@ filegroup( "//internal/httpclient/encode:repo_doc_files", "//internal/httpclient/wire:repo_doc_files", "//internal/idgen:repo_doc_files", + "//internal/initprocs:repo_doc_files", "//internal/jira:repo_doc_files", "//internal/linear:repo_doc_files", "//internal/lockfile:repo_doc_files", @@ -383,6 +405,7 @@ filegroup( "//internal/storage/externaldeps:repo_doc_files", "//internal/storage/fs:repo_doc_files", "//internal/storage/git:repo_doc_files", + "//internal/storage/historyoffequiv:repo_doc_files", "//internal/storage/issueops:repo_doc_files", "//internal/storage/journalscan:repo_doc_files", "//internal/storage/kvkeys:repo_doc_files", @@ -413,6 +436,7 @@ filegroup( "//internal/utils:repo_doc_files", "//internal/validation:repo_doc_files", "//internal/versioncheck:repo_doc_files", + "//internal/versionedhistory:repo_doc_files", "//internal/workapi:repo_doc_files", "//internal/workapi/storecounter:repo_doc_files", "//internal/workapi/storequerier:repo_doc_files", @@ -578,6 +602,7 @@ filegroup( "//internal/httpclient/encode:repo_go_srcs", "//internal/httpclient/wire:repo_go_srcs", "//internal/idgen:repo_go_srcs", + "//internal/initprocs:repo_go_srcs", "//internal/jira:repo_go_srcs", "//internal/linear:repo_go_srcs", "//internal/lockfile:repo_go_srcs", @@ -617,6 +642,7 @@ filegroup( "//internal/storage/externaldeps:repo_go_srcs", "//internal/storage/fs:repo_go_srcs", "//internal/storage/git:repo_go_srcs", + "//internal/storage/historyoffequiv:repo_go_srcs", "//internal/storage/issueops:repo_go_srcs", "//internal/storage/journalscan:repo_go_srcs", "//internal/storage/kvkeys:repo_go_srcs", @@ -647,6 +673,7 @@ filegroup( "//internal/utils:repo_go_srcs", "//internal/validation:repo_go_srcs", "//internal/versioncheck:repo_go_srcs", + "//internal/versionedhistory:repo_go_srcs", "//internal/workapi:repo_go_srcs", "//internal/workapi/storecounter:repo_go_srcs", "//internal/workapi/storequerier:repo_go_srcs", @@ -797,6 +824,7 @@ filegroup( "//internal/httpclient/encode:repo_go_test_srcs", "//internal/httpclient/wire:repo_go_test_srcs", "//internal/idgen:repo_go_test_srcs", + "//internal/initprocs:repo_go_test_srcs", "//internal/jira:repo_go_test_srcs", "//internal/linear:repo_go_test_srcs", "//internal/lockfile:repo_go_test_srcs", @@ -836,6 +864,7 @@ filegroup( "//internal/storage/externaldeps:repo_go_test_srcs", "//internal/storage/fs:repo_go_test_srcs", "//internal/storage/git:repo_go_test_srcs", + "//internal/storage/historyoffequiv:repo_go_test_srcs", "//internal/storage/issueops:repo_go_test_srcs", "//internal/storage/journalscan:repo_go_test_srcs", "//internal/storage/kvkeys:repo_go_test_srcs", @@ -866,6 +895,7 @@ filegroup( "//internal/utils:repo_go_test_srcs", "//internal/validation:repo_go_test_srcs", "//internal/versioncheck:repo_go_test_srcs", + "//internal/versionedhistory:repo_go_test_srcs", "//internal/workapi:repo_go_test_srcs", "//internal/workapi/storecounter:repo_go_test_srcs", "//internal/workapi/storequerier:repo_go_test_srcs", @@ -1025,6 +1055,7 @@ filegroup( "//internal/httpclient/encode:repo_other_files", "//internal/httpclient/wire:repo_other_files", "//internal/idgen:repo_other_files", + "//internal/initprocs:repo_other_files", "//internal/jira:repo_other_files", "//internal/linear:repo_other_files", "//internal/lockfile:repo_other_files", @@ -1064,6 +1095,7 @@ filegroup( "//internal/storage/externaldeps:repo_other_files", "//internal/storage/fs:repo_other_files", "//internal/storage/git:repo_other_files", + "//internal/storage/historyoffequiv:repo_other_files", "//internal/storage/issueops:repo_other_files", "//internal/storage/journalscan:repo_other_files", "//internal/storage/kvkeys:repo_other_files", @@ -1094,6 +1126,7 @@ filegroup( "//internal/utils:repo_other_files", "//internal/validation:repo_other_files", "//internal/versioncheck:repo_other_files", + "//internal/versionedhistory:repo_other_files", "//internal/workapi:repo_other_files", "//internal/workapi/storecounter:repo_other_files", "//internal/workapi/storequerier:repo_other_files", diff --git a/CHANGELOG.md b/CHANGELOG.md index a5618ca17..884a0d7f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,189 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added +- `bd versions ` lists the versions recorded for a bead, and + `versioned-history.enabled` turns recording on. While it is on, every + accepted change to a bead created while it is on, or that enters the issues + plane while it is on (a wisp promoted or made persistent), stores a + snapshot of it as a row of `issue_versions` in the same transaction. It is + off by default and nothing is backfilled: a bead already on the issues + plane when it is turned on is legacy, and editing it records nothing. A + recorded write leaves `updated_at` where an unrecorded one would, so + `bd import`'s stale check sees the same timestamps either way. + `bd versions --json` answers `{"versions": [...], "recording": bool}`; the + command still lists what was recorded after recording is turned off, and + proxied-server and HTTP workspaces refuse it. The setting is a row of each + store's `config` table (`bd config set versioned-history.enabled true`), + and every store reads its own when it is opened: a write routed into + another workspace (a prefix-routed `bd update` or `bd close`, + `bd create --repo`) follows the target store's row, a proxied-server + provider reads it when it is constructed, and a long-lived `bd serve` + keeps the value it read until it restarts. + `BD_VERSIONED_HISTORY_ENABLED=1` (or a `config.yaml` value) turns + recording on for every store the process opens, and never turns it off. + The row replicates on `bd dolt push`/`pull`, and recording is single-writer + only: two clones recording at once can mint the same revision and fail the + pull, and a write from a writer that is not recording is folded into the + next recorded version under that version's actor, so keep recording on for + every writer of a store or off for all of them. Turning it on with + `bd config set` first checks every issue the store would version and + refuses, writing nothing, while any holds a number outside the I-JSON + exact-integer range (magnitude above 2^53-1, however it is spelled) in its + metadata or in a gate's timeout (held as nanoseconds, so about 104.25 + days), and prints the count, the ids, the field and the fix. There is no + override, and the check runs once; after that, a recorded write that would + hold such a number fails atomically. Migration 0071 adds a nullable + `removed_restriction` column to `issue_versions`. `bd version` now refuses + an argument and suggests `bd versions `, instead of printing bd's + build for a mistyped `bd version bd-123`. +- `bd blocked --flags` prints the blocked flag for each id read from stdin + (one per line; blank lines and repeats ignored), with `--json` as + `[{"id","is_blocked"}]` in the order the ids were given, omitting an id that + names no row on either plane. A closed id is answered too, with its stored + flag (a `status <> 'closed'` SQL read of the column leaves it out). It is the flag `bd ready` filters on, not the + listing: a row whose stored flag is set with no nameable blocker reads true + here and is absent from `bd blocked`. It runs `issueops.BlockedFlags` on + every route; over HTTP that is `listBlockingAnnotations` with `is_blocked`, + behind `dependencies.blocking.isBlocked`, refused before the dial against a + server that does not advertise it. The listing's filter flags are refused + with `--flags`. +- `bd blocked --flags --raw` answers the stored `is_blocked` column itself, + without the external-dependency policy: a row blocked only by an + unsatisfied `external:` ref reads `false` (the policy-aware `--flags` + reads `true`); a stale flag reads `true` either way. `--raw` is for the + local and proxied routes, where it reads the column directly and the two + answer the same. Over HTTP it is answered only by a server that does not + advertise `policy.external_dependencies` (whose flag is the column); a + server advertising it answers only the policy-aware flag, so `--raw` + against it is refused before the dial rather than answered with the + decorated flag. `--raw` without `--flags` is refused. +- `bd blocked` works over a connected HTTP workspace. The blocked listing is + a role, `issueops.BlockedLister` (`ListBlocked(BlockedRequest{ParentID, + Labels, LabelsAny, ExcludeLabels}) -> BlockedResult{Items}`), on every + backend leg over the same body `GetBlockedIssues` runs, and `bd serve` + publishes it as `GET /v0/beads/blocked` (`parent`, and the repeatable + `label`, `label_any` and `exclude_label`), answering `{items, has_more}` + with `BlockedIssue` rows (the element `bd blocked --json` prints), behind + the new `blocked.list` capability token (additive; no wire_revision bump). + The listing names unsatisfied `external:` blockers wherever the + external-dependency policy applies: on the server when it advertises + `policy.external_dependencies`, else on the client, as every other policy + read does. The HTTP backend's `BlockedLister()` and legacy + `GetBlockedIssues` dial it; against a server that does not advertise the + token they refuse before dialing with a typed capability error naming + `blocked.list`, and never compose the listing from other reads. The + listing is unpaged: a server answer that reports `has_more` is refused + with the new `httpclient.TruncatedListingError` rather than returned + short, and an answer over the client's 32 MiB response limit is refused + as any oversized response is. The external-dependency decorator's legacy + `GetBlockedIssues` over an HTTP store now reads the extra sources through + the served roles (it failed on a raw multi-id read before), so callers of + that door no longer fail on it; commands that also make other raw reads + the HTTP backend does not serve (`bd ready --explain`) still refuse on + those. `bd + blocked` runs the role on every route (the proxied-server route through + the provider's accessor) with unchanged output: `--json` prints the same + rows in the same order (priority, then newest first, then id, which now + also breaks a tie the order used to leave to chance), and `[]`, never + `null`, when nothing is blocked. +- `bd list`'s remaining filters work over a connected HTTP workspace. + `GET /v0/beads/issues` accepts `updated_after`/`updated_before`, + `closed_after`/`closed_before`, `defer_after`/`defer_before`, + `due_after`/`due_before`, `priority`, `priority_min`, `priority_max`, + `title_contains`, `desc_contains`, `notes_contains`, `external_contains`, + `external_ref`, `spec`, `label_pattern`, `label_regex`, + `empty_description`, `no_labels`, `no_parent`, a repeatable + `exclude_type`, `pinned`, `no_pinned`, `deferred`, `overdue`, `mol_type` + and `wisp_type`, behind one new capability token, `issues.list.filters` + (additive; no wire_revision bump; the names are `issues:count`'s where it + already spells the filter), and applies them through the same Reader role a + local `bd list` reads through. Bounds are strict and compared at + whole-second precision on both routes; relative and date-only values are + resolved on the client's clock and timezone as locally, while `--overdue` + compares against the server's clock. Against a server that does not + advertise the token the client refuses before dialing, naming + `issues.list.filters`, rather than sending a filter an older server rejects + or dropping one and answering a wider listing. The 29 corresponding + divergence-ledger refusal rows are removed. The default `bd list --parent` + tree view does not carry these filters yet: its descendant walk still + refuses one over HTTP rather than drop it, and `--flat` or `--json` skips + the walk and applies them to the parent's direct children (not its whole + subtree). +- `issueops.ListRequest.ExcludeStatus`: statuses to leave out of a listing, + appended to the default exclusions (never re-admitting what they hide), + comma-separated or repeated, each validated against the workspace's + statuses like `CountRequest.ExcludeStatus` (an unknown name is + `ErrValidation`). `GET /v0/beads/issues` accepts it as a repeatable + `exclude_status` under the same `issues.list.filters` token (an unknown + name is a `400` on `exclude_status`), so an HTTP-backed caller can leave + closed history out of an `all` listing (`all` plus + `exclude_status=closed` keeps every status not named, the `pinned` and + `hooked` statuses and custom done/frozen statuses included) instead of + reading the whole history. It is refused together with `ReadyFlag`, like the other + members the ready query cannot carry. There is no `bd list` flag for it + yet. + +- `bd serve` publishes the gate members: `await_type`, + `await_id`, `timeout` (nanoseconds) and `waiters` on `POST + /v0/beads/issues` and on `issues:batchApply` create items, behind the new + `issues.create.gates` capability token, and `await_id` and `waiters` (a + whole-value replacement; `[]` clears) on the `patch` of `PATCH + /v0/beads/issues/{id}` and of `issues:batchApply` update items, behind + `issues.update.gates`. Additive; no wire_revision bump. The bounds are the + library role's, the same ones a local create or update now enforces (see + Changed), answered as `400 invalid_argument` with `param` naming the + member. +- `issueops.IssuePatch.Waiters`: a whole-value replacement of a gate's waiter + list (nil or empty clears it, stored as `[]`), on `Lifecycle.Update` and on + `BatchApplier` update items, on every backend. `issueops.GateFieldError` + (`Field`, `Detail`; wraps `ErrValidation`) names the gate member a create or + update refused, as one of the new `issueops.GateFieldAwaitType`, + `GateFieldAwaitID`, `GateFieldTimeout` and `GateFieldWaiters` constants. +- The HTTP client sends the gate members on create, update and + `issues:batchApply` (create and update items) to a server that advertises + `issues.create.gates` / `issues.update.gates`. Against an older server a + request naming any gate member is refused before the dial with a typed + capability error naming the missing token (never sent without the + member); a batchApply plan is checked whole, so no partial plan is sent. + A request naming no gate member is unaffected by either token. +- `bd heartbeat` works over a connected HTTP workspace. + The lease refresh is a role, `issueops.Heartbeater` + (`Heartbeat(HeartbeatRequest{Actor, IssueID}) -> HeartbeatResult{IssueID, + Holder, HeartbeatAt, LeaseExpiresAt, Rearmed}`), on every backend leg, and + `bd serve` publishes it as `POST /v0/beads/issues/{id}:heartbeat` behind the + new `issues.heartbeat` capability token (additive; no wire_revision bump), + with the new `lease_not_held` (409) problem code (`reason: ephemeral` for a + wisp). A refresh writes ONLY the lease row: the issue's `revision` is not + reminted (a guarded write against the pre-heartbeat token still lands), no + version, event, journal entry or Dolt commit is recorded, and no hook + fires. `Rearmed` is true only when the heartbeat created the caller's lease + row (a hand-doled claim's first heartbeat). A re-arm is recorded as a + mutation; a refresh is not: the re-arm remints `revision`, stamps + `updated_at`, records a `lease_rearmed` event, a journal entry and a + version, makes a Dolt commit and fires `on_update` (see Fixed); the + reported times are whole seconds, exactly what the lease row stores. The + HTTP backend's `Heartbeater()` and legacy `HeartbeatIssue` dial it; + against a server that does not advertise the token they refuse before + dialing with a typed capability error naming `issues.heartbeat`, and never + fall back to a re-claim or a metadata stamp. A + busy (503) answer is replayed, because a repeat only moves the expiry later. + `bd heartbeat` now runs the role on every route (the proxied-server route + through the provider's accessor), with the same + `{"id","status":"heartbeat","owner"}` success output and the same exit + codes. Refusal TEXT on stderr changes per route: the direct routes (Dolt + server, embedded) gain a `lease not held: ` prefix + (`heartbeat X: lease not held: issue not claimable: X status closed`); the + proxied-server route loses its + `Heartbeat: db: IssueSQLRepository.HeartbeatIssue: ` prefix and reads as the + direct routes do; over HTTP the refusal is the problem's detail, which names + the state found (`it is closed`, `an ephemeral wisp`, `open and not + claimed`) or, for a foreign holder, the native `issue already claimed by + `. An id that names no row answers not-found from the role rather + than "not claimable" (the CLI resolves the id first, so its output is + unchanged), and every refusal for a caller that holds no live claim + (closed, released, reclaimed, moved off in_progress, or a wisp) is + `issueops.ErrLeaseNotHeld`, which still matches `ErrNotClaimable`. + - `GET /v0/beads/dependencies/blocking` accepts `is_blocked`, behind the new `dependencies.blocking.isBlocked` capability token (additive; no wire_revision bump), and answers each item's stored, transitive @@ -316,6 +499,80 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- Over an HTTP workspace, `bd ready --json` without `BD_JSON_ENVELOPE` no + longer sends `GET /v0/beads/ready:count` after a page the limit cut short: + the total only went into the stderr hint. It lists one row past the limit + instead, and the hint says more issues matched without saying how many + (the wording the proxied-server route already uses). A local store, and the + envelope's `pagination.total`, keep the total. +- `bd` initializes its packages with `GOMAXPROCS` capped at 4 and hands it + back before `main` runs anything, so the garbage collections package + initialization triggers do not stop the world across every CPU of a large + host. On a 192-CPU machine this takes about 17 ms off every bd process. An + explicit `GOMAXPROCS` is restored as set. +- Over an HTTP workspace, `bd ready` no longer fetches `GET /v0/beads/context` + before its listing in every process only to learn whether the server + enforces the external-dependency policy. The answer is kept for 5 minutes + per server URL and pinned project under the user cache directory + (`BEADS_HTTP_POLICY_CACHE_TTL`, a duration, a number of seconds, or `off`), + and a handshake the process already holds still wins. Claims and closes + always ask the server. +- `bd serve` normalizes every RFC 3339 time bound on the issue listing and + count (`created_*`, `updated_*`, `closed_*`, and the new `defer_*` and + `due_*`) to UTC before it reaches storage. A bound carrying an offset + (`...+02:00`) now selects exactly what its `Z` twin does; previously a + backend whose timestamp column has no zone could read the offset bound's + wall clock and compare it hours off. `bd`'s own client always sent `Z`, so + its answers are unchanged. +- `bd serve` answers a `label_regex` the database cannot compile with + `400 invalid_argument` (`invalid_value` on `label_regex`) on + `GET /v0/beads/issues`, `GET /v0/beads/ready`, `GET /v0/beads/ready:count` + and `POST /v0/beads/issues:claimNext`, instead of `500 internal`. The pattern is + still compiled by the database in its own dialect; only the attribution + of its refusal changed. +- `issueops.Reader.List` refuses `PinnedFlag` together with `NoPinnedFlag` + with `ErrValidation` (`--pinned and --no-pinned are mutually exclusive`) on + every backend; it used to let `PinnedFlag` win silently. `bd list` already + refused the pair at flag parse, so its behavior is unchanged; over HTTP the + pair is a `400 invalid_argument` on `no_pinned`. +- `issueops.Reader.List` refuses `ParentID` together with `NoParent` with + `ErrValidation` (`--parent and --no-parent are mutually exclusive`) on + every backend, as `CountRequest` already did; it used to answer with only + the edge-less rows under the parent's dotted id, which both clauses match. + `bd list` already refused the pair at flag parse, so its behavior is + unchanged; over HTTP the pair is a `400 invalid_argument` on `no_parent`. + +- **`bd gate discover` skips template gates, as `bd gate check` does.** A + template gh:run gate is a proto that work is poured from; on the direct, + proxied and embedded routes `bd gate discover` used to record a discovered + run ID on it, which every later pour copied. It is now left alone on every + route. `bd gate add-waiter` on a template gate is refused by the update + role's template guard, where the direct, proxied and embedded routes all + used to write the waiter. +- **`bd gate create` refuses a negative `--timeout` on every route** + (`timeout cannot be negative`); the direct, proxied and embedded routes + used to store it. A `--type` longer than 32 characters fails with the same + typed validation error instead of a raw Dolt column error. +- **`bd gate create` and `bd gate add-waiter` follow `dolt.auto-commit` + like every other role write.** Under `dolt.auto-commit=off` `bd gate + create` no longer makes its own Dolt commit on the direct and embedded + routes (the proxied route already did not). The Dolt commit messages are + the role's: `bd: create gate X blocking Y` becomes the create's default + message, and `bd gate add-waiter`'s becomes the update's (`bd: update X` + on the direct and embedded routes, `update issue` on the proxied route). + On the proxied route `bd gate create` no longer journals a + `dependency_added` event on the blocked issue, matching the direct route + and `bd create --deps`. +- **Gate members are bounds-checked in the library, on every local backend.** + `issueops.Lifecycle.Create`, `Lifecycle.Update` and `BatchApplier` (create + and update items) now refuse, with a typed `*issueops.GateFieldError` + wrapping `ErrValidation`: a negative `Timeout` (previously accepted and + stored), an `await_type` over 32 characters, an `await_id` over 255 + characters, and a waiter list whose JSON encoding exceeds its TEXT column + (65535 bytes). Creates check all four; an update can change only + `await_id` and `waiters`, so it checks those two. The over-width values + previously failed with a raw Dolt driver error. There is no `await_type` vocabulary, no gate-type-only rule + and no waiter deduplication. - **Over an http workspace, a bd command answers its repeated reads of a row or setting from one response.** `bd show --json` makes one request instead of three, text `bd show` three instead of six, and `bd update`, @@ -524,6 +781,392 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed +- An HTTP workspace whose server cannot be reached now says which step + failed. A connect that is refused names the address and says nothing is + listening; one that times out (a filtered port, a down host) names the + address that never answered and how long it waited; a host name that does + not resolve is named as such. The error was the transport's + `Get "https://…/v0/beads/context": dial tcp …: i/o timeout`, which named the + request rather than the address. +- **`bd link` works over a connected HTTP workspace.** It wrote through the + store's raw `AddDependencyWithOptions`, which the HTTP client refuses, so + every `bd link` failed there with `operation "AddDependencyWithOptions" not + supported by the http backend`, whatever the type. It now writes through + the `DependencyEditor` role, the route `bd dep add` takes, on the direct + and HTTP routes alike (the proxied-server route is unchanged). Over HTTP + that is one `dependencies:add` request, so `bd link` keeps accepting any + non-empty type of at most 32 characters (`owned-by`, `ships-in`, ...). + An empty or over-long type is still refused before anything is written, + and an edge that already exists with another type still reports the typed + conflict. On a Dolt store the history commit is now the role's, like + `bd dep add`'s: `bd: dep add ` in place of + `dependency: add -> `. + +- **`bd query` reports an uppercase duration unit as an unparseable time, not + a negated internal error.** `created>30M` failed with + `not a compact duration: "-30M"`, naming a value nobody typed; it now fails + with `cannot parse time expression: "30M"`. A signed spelling + (`created>+30M`) stops at the parser, as `created>+30x` already did, so + quote one to match it as a literal (`label="+30M"`). Units remain lowercase + (`30min`, `6h`, `7d`, `2w`, `3m`, `1y`); help and docs already say so. +- **Strict `--readonly` no longer creates workspace gate files.** A + `bd --readonly` command took its shared workspace gates with + create-if-missing, so on a workspace no bd command had gated yet it left + `/.beads.gate.lock` and the physical-root gate file + (`.beads/embeddeddolt.gate.lock` or `.beads/dolt.gate.lock`) behind, although + strict readonly promises not to mutate the workspace. It now opens an + existing gate file read-only and holds it shared as before, so a maintenance + operation still sees it and a running one still makes it wait; when no gate + file exists it holds nothing. Every other command still creates the files. +- **Strict `--readonly` refuses `bd backup init`, `backup sync`, + `backup remove`, `backup restore` and `bd import`.** None of them checked + readonly mode. On a server-mode store they ran to completion under + `--readonly`: `backup init` and `backup remove` rewrote or emptied the + server's backup registry, `backup sync` wrote the backup destination, + `backup restore --force` replaced the store, and `import` wrote issues. On + an embedded store they failed with the storage layer's `store is read-only` + error instead, after `backup sync` had left `.beads/backup.lock` behind and + `backup restore` had left workspace-gate holder files. They now exit 1 with + the standard `Error: operation '' is not allowed in read-only mode`, + and a restore is refused before it takes the exclusive workspace gate. + `bd import --dry-run` is refused too, as `bd create --dry-run` already is + and as a migration freeze already refuses it. `bd backup status` still runs + under `--readonly`. +- **`bd init --server --external` no longer starts a Dolt server of its own.** + Init builds its store config by hand and turned auto-start on for every + server init, so an `--external` init that named no port launched a + repo-local `dolt sql-server`, although `--external` says the server is + managed outside bd. `--external` now turns auto-start off. When the + external server cannot be reached, init gives one message on every route + (host and port, socket, shared server, auto-start pinned off): it names the + endpoint it dialed, says that bd did not start a server, and no longer + advises `bd dolt start`. With no port named at all, it asks for one + (`--server-port` or `BEADS_DOLT_SERVER_PORT`) instead of offering a default. +- **A failed `bd init --server` can be retried.** A first attempt that could + not reach its server left an empty `.beads/dolt` and nothing on disk that + records the server choice, so the legacy-upgrade guard refused every retry + as a "legacy Dolt workspace" and no bd command could repair it. When init + itself selects server mode, the guard now admits exactly that root: empty, + with no `.local_version` witness. A pre-1.0 witness, or a `.beads/dolt` that + holds anything, is still refused, and commands other than `bd init` are + decided as before. +- **A graph-mode workspace is refused instead of opened as an Issue store.** + Graph-preview builds mark their workspaces with `"graph_mode": "link"` and + `graph_*` binding fields in `metadata.json`, beside an ordinary Dolt + backend. bd opened such a workspace as an Issue store and ran Issue schema + initialization against the graph database, and every `metadata.json` rewrite + (including the `config.json` to `metadata.json` migration) dropped the + marker and the binding. Now any `graph_mode` other than `dependency`, + including a value bd does not recognize, makes every command that runs in + the workspace or names it with `--db` or `BEADS_DB` (`bd init`, `bd doctor` + and `bd bootstrap` included), and `bd create --repo` aimed at it, refuse it + before touching anything. The refusal names the format and exits with code + 16, so installed beads git hooks refuse commits and pushes there too. + Commands that reach such a workspace only through a route from another + one, such as a routed `bd show`, fail without touching it, but not with + code 16. Store-less commands such as `bd version` and `bd help` still run. + A `metadata.json` rewrite keeps `graph_mode` and the `graph_*` fields + graph-preview builds write, and like those builds it omits a zero + `graph_schema_version` and a false `graph_ready`. +- **A graph workspace without `graph_mode` in its metadata is refused too.** + Graph-preview builds write a `.beads/graph-preview-format` marker before + `metadata.json`. bd ignored it. When an older bd had rewritten + `metadata.json` without `graph_mode`, bd opened the graph database by its + recorded name and ran Issue schema initialization against it; when + `metadata.json` was never written or was lost, bd fell back to the default + database name and created an Issue database inside the graph workspace, and + `bd init` initialized an Issue workspace there. A `.beads` holding that + marker, whatever it contains and whatever its metadata says (absent, + stripped, unparseable or an explicit `dependency`), is now refused wherever + a `graph_mode` workspace is: commands run in it or naming it with `--db` or + `BEADS_DB`, `bd create --repo` aimed at it, and `bd bootstrap` in a + workspace below it that would take its metadata exit with code 16 and a + hint to restore `metadata.json`, and routed and cross-repository opens fail + without opening its database. +- **The Go library's opens refuse a graph workspace too.** + `beads.OpenBestAvailable`, `OpenBestAvailableWith`, `OpenFromConfig` and + `OpenGated` opened a workspace whose `metadata.json` declares a + `graph_mode` other than `dependency`, or whose `.beads` holds the + `graph-preview-format` marker, as an Issue store and ran Issue schema + migrations into the graph database. They now + return `*beads.UnsupportedWorkspaceFormatError` (match it with `errors.As`) + before opening, creating or changing anything, the same refusal the CLI + exits 16 with. +- **`bd setup claude --remove` no longer leaves a blank-line hole.** Removing + the beads section from `CLAUDE.md` (or, with the other setup recipes, from + `AGENTS.md` or `GEMINI.md`) left the blank lines around it behind, three in + the `CLAUDE.md` `bd init` writes, and setup then re-added the section after + two more, so every remove and re-add grew the file. `--remove` now takes + those blank lines with the section, and setup appends a section after one + blank line, so removing and re-adding it toggles between the same two files. + A re-added section goes at the end of the file. +- **`bd config set` no longer truncates a `config.yaml` that has a line of + 64 KiB or more.** Setting an undotted key (such as `actor` or `no-db`) + rewrites the file line by line, and a line of 65,536 bytes or more ended + that read early without an error, so the command reported success and wrote + back only the lines before the long one, plus the key it set. Dotted keys + and `bd config unset` were not affected. Setting an undotted key in such a + file now fails with `bufio.Scanner: token too long`. `bd config set` leaves + the file as it was. `set-many` stops at that key, but it has already written + any `config.yaml` keys listed before it, such as a dotted `sync.remote`. +- **`bd show --as-of` exits 1 when it reads no issue.** A ref the Dolt AS OF + read does not take (an instant, a versioned-history address), a ref that + does not exist, or an issue that did not exist at the ref was reported on + stderr while the command exited 0 with nothing on stdout, even under + `--json`. It now ends the way plain `bd show` does: exit 1, with the JSON + error envelope on stdout under `--json`. A batch that reads at least one of + its ids still exits 0. Both the direct and the proxied-server routes + changed. +- **`bd list --format dot` prints the same graph the same way every time.** + Nodes are declared in id order and edges in source, target and type order. + They used to follow the listing order, which breaks a priority tie by + creation time to the second, so two equal-priority issues swapped places + depending on whether they were created in the same second, and the + proxied-server route did not pin the order of one issue's edges. `--sort` + and `--limit` still choose which issues are listed. +- **`bd init --quiet` no longer prints "Removed SessionStart hook" or "Removed + PreCompact hook"** when the project's `.claude/settings.json` (or the legacy + `.claude/settings.local.json`) still carries the bare `bd prime` hooks an + older bd registered. The hooks are still migrated to the SessionStart + `bd prime --hook-json` hook; the removal lines now go to the installer's own + output, which `--quiet` discards, instead of straight to stdout. +- **A new `AGENTS.md` from `bd init` lists `bd dolt push` in its Quick + Reference only when the workspace has a Dolt remote.** The managed Beads + section already left out its push lines when no Dolt remote is configured or + the workspace is `no-push`, but the Quick Reference above it still showed + `bd dolt push # Push beads data to remote`. It now follows the same rule. + `bd init` still leaves an existing `AGENTS.md` alone outside the managed + section, and writes an `--agents-template` as given. +- **`bd setup claude` no longer rewrites a CLAUDE.md whose beads section is + already current.** A rerun (and `bd init`, which runs it) wrote the same + bytes back as a new file, resetting its mode to 0644 and its mtime, and + reported "Updated existing beads section"; it now leaves the file alone and + reports the section current (the report `bd init` already gives a current + AGENTS.md). `bd setup factory`, `opencode`, `mux` and `gemini` share the + fix. A section whose END marker is missing or comes before BEGIN, which was + also reported as updated while nothing changed, is now reported as an error: + `bd setup factory`, `opencode` and `mux` exit 1 (`mux` before installing its + `.mux` hooks), while `claude` and `gemini` warn and carry on. When CLAUDE.md + is an `@AGENTS.md` stub and it is AGENTS.md that cannot be updated, `claude` + now names AGENTS.md in the warning and keeps the beads block left in the + stub, which it used to delete although AGENTS.md was never updated. +- **Time-bound filters and the keyset cursor compare the same instant on every + engine, whatever zone they are given in.** The storage filter builder binds + every time bound (`created_*`, `updated_*`, `closed_*`, `started_*`, + `defer_*`, `due_*`) as the UTC spelling of its instant. An engine whose + timestamp column carries no zone drops a literal's offset, so a `+02:00` + bound would have compared as that wall clock; Dolt already honored the + offset and `bd` resolves bounds to UTC, so no answer changes here. The + keyset cursor (`AfterCreatedAt`) is now bound in UTC too: embedded Dolt's + driver sends a `time.Time` as its wall clock with no zone, so a library + caller paging with a cursor in another zone was answered from the wrong + position there (server Dolt was unaffected). +- **`bd setup claude --global` keeps its beads section in `~/.claude/CLAUDE.md`.** + It wrote the section into the current directory's `CLAUDE.md`: run from your + home directory it created `~/CLAUDE.md`, which by default stops Claude Code + reading `AGENTS.md` in the projects below it, and `--remove --global` + stripped the section a project's own install had put in its `CLAUDE.md` + while leaving that project's hooks in place. A global install and removal now + use only the user-level files beside `~/.claude/settings.json`. A new + `~/.claude/CLAUDE.md` holds just the section, rendered the same whichever + project you run from. Claude Code loads that file in every project, so its + section, task-tracking rules included, applies only in repositories that use + beads. With global or plugin hooks `--check` accepts it when the project's + instructions have none, or names `--global` when it is missing and the + project has no `CLAUDE.md` of its own. Run from `~/.claude`, + or from your home directory unless `~/CLAUDE.md` still holds a section an + earlier run left there, `--check` judges the user-level files, and from your + home directory it names `--global` when no hooks are installed. From your + home directory, whose `.claude/settings.json` is the global one, `--remove` + removes the user-level section with the hooks. If you ran `--global` before, + re-run `bd setup claude --global` to add the section to `~/.claude/CLAUDE.md`. + A section an earlier `--global` run left in a directory's `CLAUDE.md` stays + there; delete it by hand if you don't want it. +- **`bd blocked --label`, `--label-any` and `--exclude-label` apply to a row + blocked only by an unsatisfied `external:` dependency.** The + external-dependency policy lists such a row itself, after the label query + has run, and it was listed whatever its labels; it is now narrowed by the + label filters like every other row, on every route. On the proxied-server + route such a row also printed with no labels; it now prints them. +- **`bd gate add-waiter` survives contention the store gave up replaying.** + It retried only a version miss, so a convoy adder failed when its guarded + write ended in a serialization failure or deadlock the backend stopped + replaying (Dolt/MySQL 1213/1205, Postgres 40001/40P01), or, over HTTP, in a + 503 busy. Those are now retried, but at most twice: each arrives only after + the store or `bd serve` has spent a whole replay budget on the write (up to + 15s), so the 20-write bound a version miss gets could hold an adder for + minutes. Each retry waits the jittered backoff plus a busy answer's + Retry-After, as `bd serve` sent it. The retry is safe because every round + re-reads the gate, deduplicates and writes the whole list guarded by the + version it read: a 503 is not proof that nothing was written (a gateway can + answer one after the commit), and a write that did land is found on the + re-read, so the waiter is never added twice; when the last write allowed is + answered busy, one more read checks for it before the command fails. A + server fault (500) and an unreachable database are still returned at once, + and once the retries run out the error says no write was confirmed and + names the write contention, instead of saying the gate kept changing. +- `bd list --title-contains X` works against an HTTP workspace. The client + folds it onto the listing's existing `title` parameter (the store compiles + both flags to the same case-insensitive substring predicate), so it needs + the `issues.list.title` capability, like `--title`. A `--title` and a + `--title-contains` that differ other than in letter case are two + predicates, so they ride `title` and `title_contains` together and also + need `issues.list.filters` (see Added), as does the `--closed-after` in + gascity's polecat pre-flight lookup of recently closed beads. Either flag + with `--parent` in the default tree view still refuses over HTTP. +- **`bd gate create`, `bd gate add-waiter` and `bd gate discover` work over a + connected HTTP workspace.** They wrote through the legacy `CreateIssue`, + `AddDependency` and map-based `UpdateIssue`, which the HTTP store does not + implement, so each failed before any gate member reached the wire. They now + run through the library roles on every route: + - `bd gate create` is ONE `Lifecycle.Create` carrying the gate members and + a reverse `blocks` edge from the blocked issue to the new gate, so the + gate and its edge land atomically (one `createIssue` over HTTP, behind + `issues.create.gates`). The direct route used to make two writes and an + explicit commit; the proxied-server route now uses the same role. + - `bd gate add-waiter` reads the gate through `Reader.Get`, deduplicates, + and writes the whole waiter list through `Lifecycle.Update` guarded by + the row version it read. On a version mismatch it re-reads and retries + after a jittered, doubling backoff (10 ms up to 400 ms per wait, at most + 20 writes), so a convoy of workers registering on one gate at once all + succeed. On the direct route concurrent adders used to lose + each other's waiters while every one exited 0; no waiter is lost now. + Over HTTP it needs `issues.update.gates`. + - `bd gate discover` lists through `issueops.ListGates` (as `bd gate check` + does) and records each discovered run ID through `Lifecycle.Update`, the + same `await_id` write `bd gate check` and `bd close` make. Over HTTP it + needs `issues.update.gates`. Its summary now counts only the gates whose + run ID was recorded, and it exits non-zero when any matched gate's write + failed (it used to report such a gate as updated and exit 0). + + Against a server that does not advertise the token it needs, `bd gate + create` and `bd gate add-waiter` are refused before any write, naming the + token; `bd gate discover` writes nothing and reports the token as that + gate's error. The served corpus gains `mc-gate-create-timer`, + `mc-gate-check-timer-resolves`, `mc-gate-add-waiter` and + `mc-update-await-id` (pending until the reference server advertises the + gate tokens), pinned passing by `TestE2E_GatesOverHTTP`. +- **`bd import` no longer reports a failed dependency check as a skipped + dependency.** Import skips an edge the dependency checks refuse (a + self-dependency, a cycle, or a blocker that is the issue's own ancestor or + descendant) and reports it on a `Skipped dependency:` line, or in + `skipped_dependencies` with `--json`. It did the same when the check's own + query failed, for example on a timeout, a dropped connection or a statement + the backend could not run: the SQL error became the skip reason, and on + Dolt, where the transaction survives a failed statement, the import + committed without the edge and exited 0. Such an error now fails the + import. Refused edges are still skipped as before. + +- **`bd mol bond ` ignored prefix routing** — operand resolution now uses + the same routing fallback as `bd show`/`bd update`/`bd close`, so a bead that + lives in a routed store (a prefix-routed rig via `routes.jsonl`, or the + contributor planning store) resolves instead of failing with `'' not found + as issue or formula`. Previously `bd mol bond` resolved operands + against the local store only, so `gt sling ` — which cooks the + default formula and bonds it to a rig-routed bead — died at `bd mol bond` even + though `bd show ` resolved the same ID. Resolution is write-intent: the + routed target opens writable and the bond commits where the bead lives. Two + operands that live in the same routed rig share one store handle and bond + normally; only a bond whose operands resolve to genuinely different databases + is rejected rather than written to the wrong one. As part of this change, an + auto-route — contributor, maintainer or default — now opens writable for the + commands that change an existing issue (`bd update`, `bd close`, + `bd comment`, `bd unclaim`, `bd dep` and the other routed mutation commands, + as well as `bd mol bond`), so the write commits where the issue lives: for a + contributor, in the planning repository, as the contributor workflow + documents. Every auto-route used to open read-only, so on an embedded + workspace these writes were refused. `bd unclaim` now opens a routed issue + writable, as `bd update --claim` does, and commits the release there; on an + embedded workspace `bd human respond` and `bd human dismiss` now record a + routed change as a Dolt commit in the routed repository instead of leaving it + uncommitted in that repository's working set. A routed + write, prefix or auto, never creates the target's database: an embedded + repository that has not been bootstrapped yet fails the write instead of + gaining an empty database that `bd bootstrap` would then take for the real + one. An auto-routed store, read or write, now opens the target's own + configured `dolt_database`, as a prefix route already did, even when + `BEADS_DOLT_SERVER_DATABASE` names the current workspace's database. An + auto-routed write refuses a target whose `metadata.json` is unreadable or + names no `dolt_database`, while a target with no `metadata.json` at all (a + planning repository nothing has been created in yet) opens the one embedded + database it holds, or its default database when it holds none or several; a + prefix route still requires the target's `dolt_database`. A + routing failure, such as an unreadable `routes.jsonl` or a + routed store that fails to open, is now reported as itself instead of as + `no issue found matching`. Same routing-parity fix as + [#3608](https://github.com/gastownhall/beads/issues/3608) for `bd close`. + Fixes [#4714](https://github.com/gastownhall/beads/issues/4714). + +- **`bd gate check` works over a connected HTTP workspace.** Its open-gate + listing built the same raw `SearchIssues` filter `bd gate list` did before + S20, so the HTTP backend refused the command before reading a gate and gc's + core `gate-sweep` order (`bd gate check --type=timer --escalate`) failed on + every remote scope. It now lists through `issueops.ListGates` over the + route's Querier (direct, proxied and remote alike). Closing a resolved gate + was already served. A bead gate's first sighting of its awaited bead + (`await_seen`, recorded when the check finds that bead, not yet closed, in + the gate's own store) was written through the legacy map-based + `UpdateIssue`, which the HTTP store does not implement, so every open bead + gate with an open target was an error on every sweep; it now goes through + the Lifecycle role's `Update` (a single-key metadata set, `issues.update` on + the wire), as does the gh:run discovery's `await_id` persist, which the + HTTP client sends to a server that advertises `issues.update.gates` (see + Added). Against an older server it refuses that patch before the dial, so a + gh:run gate with a workflow-name hint stays that gate's error, naming the + missing token and the server rather than a Go method. + The sweep also skips the gates of a persisted proto + (`bd cook --persist`): they are templates that every pour copies, so a + write to one was refused on every sweep and, in a local workspace, a + resolved one (an expired timer, say) was closed in the proto itself. The + listing's query leaves them out (`template=false`), so they take no row of + `--limit` and cannot crowd a live gate out of the sweep; `bd gate list` + still lists them. A negative `--limit` is now an error; the direct and + proxied routes used to read it as no limit. The served corpus gains + `mc-gate-check-timer`, `mc-gate-check-gh`, `gate-check-all` and a served + test over await-typed and template gates. + +- **`bd list`'s text renderings read only the listed issues' dependency + edges.** The tree (the default), `--deps`, `--parent`, `--format` and + `--watch` loaded every dependency record in the workspace + (`GetAllDependencyRecords`) to draw one page. Over a connected HTTP + workspace that is a walk of the whole workspace: every issue id, 200 per + request, then every id's edges, 100 per request. `bd list --limit 20` + against a ~3,800-issue workspace made 62 sequential requests (~5.7 s at + ~50 ms a round trip). Every rendering reads only edges a listed issue owns, + so the listing now reads exactly those through the `EdgeReader` role: one + request per 100 listed ids over HTTP. The same listing makes 6 requests + (~0.5 s), one more than `bd list --json`, and prints the same bytes. On a + local store a default page is as fast or faster. A listing that covers most + of a large store now pays batched reads (four queries per 200 listed ids) + instead of one scan of both edge tables, which costs more past roughly + 1,000 listed rows: +0.07 s at 1,000 rows and +0.46 s at 4,000 on embedded + Dolt. A store with many wisps, whose edges the old read also scanned, is + faster at every page size. +- A heartbeat can no longer resurrect a lease after a release or close. A + heartbeat re-arming a hand-doled claim (in_progress with no lease row) could + race a release or close on Dolt and leave an orphaned lease row on an open + or closed issue; every later heartbeat by the former holder then refreshed + it and answered success for a claim it no longer held. This affected every + Dolt route, including releases before this one. The re-arm is now recorded + as a mutation and remints the issue's row_lock, which every claim-ending + path rewrites, so it collides with a racing release or close and one side + is replayed against the other's result (the cost: a hand-doled claim's + first heartbeat changes its `revision` once). The refresh also requires, in + the same transaction, that the issue is still in_progress under the holder, + and a refusal deletes the caller's orphaned lease row, so a lease row + orphaned any other way never answers a heartbeat. A refresh and a refusal + still make no Dolt commit on any route; a re-arm commits only its own + tables (never `DOLT_COMMIT('-Am')`), so another writer's uncommitted + batch-mode edits to other tables stay uncommitted (a re-arm stages its + tables whole, as every other direct-route write does). On embedded Dolt, a heartbeat landing in + the same second as the previous one no longer re-grants the lease + (rewriting its `granted_at` / `granted_node`), and on every route a + heartbeat whose actor is a different spelling of the lease's holder + (`gastown.mayor` for `gastown__mayor`) refreshes the lease in place, + keeping its `granted_at` and granting replica, instead of re-granting it + under this node. For a Postgres port: the + refresh now reads the issue row, so under SERIALIZABLE expect more retried + serialization failures between a holder's own edits and its heartbeat. - **`bd gate list` works over a connected HTTP workspace** (S20). The workspace-wide listing built a raw `SearchIssues` filter, which the HTTP backend refuses, so gc's `renudge-stale-human-gates` order failed on every @@ -703,6 +1346,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 negative duration and fails, even though `--age 0s`'s own contract is that every wisp qualifies. `ageThreshold <= 0` now bypasses the clock comparison entirely (#7236). +- **`bd mol wisp gc` no longer deletes a fresh step because a wisp it + depends on is abandoned.** The GC applied `--age` only to the wisps it + selected directly, then deleted their dependents at any age as long as + they were not live work, so a step created seconds earlier went with an + old wisp it depended on, and raising `--age` did not help. A dependent + now has to meet `--age` itself, by the same rule as the wisp it depends + on (including the #7236 rounding fix). One that is too young is spared + and loses its edge to the deleted wisp: an open one is collected once it + ages out, a closed one is left for `--all`, `--closed` or `bd purge`, + since without `--all` the GC reaches a closed wisp only as the dependent + of an abandoned one (#5219). - `bd create --parent` works on the HTTP backend: the create role mints the `.` child id (and inherits the parent's labels) inside the create on every route, instead of the CLI reserving it through a raw @@ -710,6 +1364,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 or without an id) and `bd mol progress` no longer answer empty or refuse over http, and `bd ready --mol` step rows carry their assignee and timestamps. +- **Server-mode config writes are committed again.** On the direct SQL-server + route, `bd remember`, `bd forget` and `bd config set|unset|set-many` wrote + the `config` table but never created a Dolt commit: `maybeAutoCommit` + returns early off the embedded route, and plain `Commit()` excludes config + (GH#2455). The rows sat in the working set, where `bd dolt push` does not + carry them, and a dirty internal key such as `status.custom` made the next + `bd dolt pull` refuse until an explicit `bd dolt commit`. With + `dolt.auto-commit` on (the default) these writes now commit right away + through the scoped `CommitConfigOnly`, which stages only `config` and the + lookup tables projected from it, so a concurrent operation's other dirty + tables are never swept; `batch` and `off` defer them to `bd dolt commit` + like every other write. `bd remember` and `bd forget` commit only user + `kv.*` rows. When an internal config key is dirty (such as the + `issue_prefix` that `bd rename-prefix` writes), the memory is still + stored but not committed: the command warns on stderr with the keys named + and exits 0, `--json` adds `committed: false`, `commit_error` and + `dirty_config_keys`, and `bd dolt commit` publishes the memory with those + keys. v1.0.1 ([#3052](https://github.com/gastownhall/beads/pull/3052)), + whose commits this restores, also warned on a failed memory commit + instead of failing the write. `bd config unset` of a yaml-only secret key + also commits its delete of a credential row an older bd stored in the + database, so HEAD, which `bd dolt push` publishes, no longer keeps it + ([#4078](https://github.com/gastownhall/beads/issues/4078)). + - **PRs based on `hotfix/**` branches now run full CI, not just cross-version historical smokes and triage labeling.** `pr.yml`, `pr-risk.yml`, `conformance.yml`, `cross-version-smoke.yml` and @@ -993,6 +1671,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 `bd context` also prints `cwd repo: git: unavailable` rather than silently omitting the one degraded state it exists to report. +- **Server-mode `bd federation sync` and `bd federation status` work with Dolt + remotes that have no stored peer credentials** + ([#5128](https://github.com/gastownhall/beads/pull/5128), fixes + [#4837](https://github.com/gastownhall/beads/issues/4837)). A remote added + by `bd federation add-peer` without `--user` or by `bd dolt remote add` has + no `federation_peers` row, and every server-mode `bd federation` push, pull + and fetch to it failed at the credential lookup with `failed to get peer + credentials: not found: federation peer `. A missing row now means no + stored credentials, as it already did in embedded mode, so the operation + runs with Dolt's own credential discovery: `bd federation sync` without + `--peer` syncs those remotes too, and `status` fetches them. Errors reading + or decrypting a stored row still fail. A mistyped `--peer` now fails with + Dolt's own unknown-remote error instead. + - **`bd comment`/`bd comments add` refuse an abbreviated id and a reserved word instead of silently resolving one to the wrong issue** ([#5393](https://github.com/gastownhall/beads/pull/5393)). `bd comment list @@ -1019,6 +1711,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 resolution never performed abbreviation matching in the first place) — a regression test now locks that in rather than leaving it undocumented. +- **`bd delete` no longer resolves an id it cannot find to a different issue + whose id begins with it.** + ([#7375](https://github.com/gastownhall/beads/pull/7375)). The direct + (embedded and server) route resolved + each id with the abbreviation-tolerant resolver, so an id that was already + gone (a retried delete, a re-run `--from-file` list, a parent whose child + survives) resolved by leading-prefix match to whichever surviving issue's id + it begins: after `fx-t00003` was deleted, `bd delete fx-t00003` previewed + `fx-t000031` and printed `bd delete fx-t000031 --force` as the next step, + and with `--force` deleted it. `--quiet` silenced the partial-id notice, so + a `--force --quiet` re-run deleted issues it never named without a word. + `bd delete` now requires an exact id on the preview and with `--force`, as + `bd comment` does and as the team-server route already did; full ids, bare + full hashes, child ids and routed ids resolve as before. An abbreviation is + refused with `issue "t000" not found: bd delete needs the full issue id, and + "t000" is only the start of fx-t000031`, naming every id it matches; under + `--if-revision` it is the guard's lost race instead (`precondition_failed`, + exit 13), as for any other gone id. This is a user-visible change: a script + or habit that deletes by abbreviation now gets that error and must pass the + full id. Reads and other writes keep accepting abbreviations; see [Working + with IDs](docs/core-concepts/hash-ids.md#working-with-ids). + - **A git hook beads never wrote is no longer reported as installed** ([#6084](https://github.com/gastownhall/beads/issues/6084)). `getHookVersion` returns no error for a readable hook file that carries no beads markers, so a @@ -1783,6 +2497,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- **`bd init` refuses to initialize directly in your home directory** + ([#4635](https://github.com/gastownhall/beads/issues/4635)). `bd init` sets + up the directory it runs in as a project: it runs `git init` there unless it + finds a repository, and installs agent files — `CLAUDE.md`, `AGENTS.md`, + `.gitignore`, `.claude/`, `.codex/`, `.cursor/`, `.agents/`. In your home + directory most of those are your agents' user-wide settings, so bd's hooks + ended up running in every project, and init did this silently under + `--non-interactive`, which engages automatically whenever stdin is not a TTY + (so: whenever an agent runs it). A project is virtually never the home + directory itself, so this now refuses with exit code `15` + (`ExitHomeDirRefused`; `13` and `14` already mean a lost conditional-write + race and a migration freeze), documented at + `docs/recovery/init-safety.md#init-home-refused`. + + Deliberately narrow: it fires only when the working directory is *exactly* + your home directory, your home is not itself a git repository (tracked + dotfiles are unaffected, but a home that only sits inside an enclosing + repository, or a `GIT_DIR` inherited from the environment, does not count), + and you did not name a `BEADS_DIR` yourself. A subdirectory of home is an + ordinary project and is never refused. If you do name a `BEADS_DIR` from + an untracked home, init sets up only that workspace: no `git init`, no + agent files or `.gitignore` in your home directory, and nothing in a + repository your home sits inside (no hooks, `beads.role`, Dolt remote taken + from its origin, or bootstrap commit) unless a flag such as `--stealth` or + `--setup-exclude` asks for it. `--force` and + `--reinit-local` do not override the refusal — they bypass the local + data-safety guard, which is a different question from "is this the right + directory". The guard runs first in init's `RunE`, ahead of every path with + an effect, including the proxied dispatch and the store-opening + `--reinit-local` pre-checks. + - **The managed shared Dolt server now opens its configured remotesapi listener** ([#6020](https://github.com/gastownhall/beads/pull/6020)). `dolt.remotesapi-port` (machine-global user config) and diff --git a/README.md b/README.md index 5760ce630..f7909900f 100644 --- a/README.md +++ b/README.md @@ -275,16 +275,40 @@ instead of 60s, because `bd serve` gives such a request its `--large-apply-ceiling` (5 minutes by default) and finishes it even after the client has given up. A server whose ceiling is raised past about 5m15s can still outlast the client. A dial or TLS timeout stays a plain connection -error, since the server never saw the request. `off` turns off only the +error, since the server never saw the request, and a connect that fails says +so: it names the address that refused the connection (nothing listening) or +never answered (a filtered port or a down host, after the dialer's 30s), or +the host name that did not resolve. `off` turns off only the header timer: a reset read is still retried, and a write's timeout is still reported as above. +Whether the server applies bd's external-dependency policy itself (the +`policy.external_dependencies` capability) is remembered for 5 minutes per +server URL and pinned project, in `beads/http-policy/` under the user cache +directory, so `bd ready` does not fetch the server's context before every +listing just to learn it. `BEADS_HTTP_POLICY_CACHE_TTL` sets that window (a +duration such as `1m`, a number of seconds, or `off`); a server restarted +with a different composition is seen once it passes. Claims and closes never +use the cached answer: they ask the server, since a stale one could skip the +client-side refusal of externally blocked work. A workspace connected without +a project pin is not cached. + `bd search`, `bd show --current` and `bd recompute-blocked` work over HTTP too, each in its own way. `bd search` asks the server's listing with its text (`q`, behind the `issues.list.search` capability) and refuses before dialing against a server that does not advertise it. `bd list --no-assignee`, `--title` and `--id` likewise ride the listing's `no_assignee`, `title` and repeatable `id`, each behind its own capability -(`issues.list.noAssignee`, `issues.list.title`, `issues.list.ids`). +(`issues.list.noAssignee`, `issues.list.title`, `issues.list.ids`), and the +rest of `bd list`'s filters (`--updated-*`, `--closed-*`, `--defer-*`, +`--due-*`, `--priority*`, the text and external-ref matches, `--spec`, +`--label-pattern`/`--label-regex`, `--exclude-type`, `--no-parent`, +`--no-labels`, `--empty-description`, `--pinned`/`--no-pinned`, +`--deferred`, `--overdue`, `--mol-type`, `--wisp-type`) ride it behind one +capability, `issues.list.filters`. Time bounds are resolved on the client as +they are locally; `--overdue` compares against the server's clock. The +default `--parent` tree view does not carry those filters yet and refuses one +rather than drop it; `--flat` or `--json` applies them to the parent's direct +children (not its whole subtree). `bd show --current` finds the actor's in-progress or hooked issue through the server's boolean query. `bd recompute-blocked` is a no-op that exits 0: the server maintains `is_blocked` on every write, and repairing a stale flag is diff --git a/RELEASING.md b/RELEASING.md index e05b73072..50acb6497 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -145,7 +145,8 @@ Before starting a release: - [ ] All tests passing (`make test`, the Bazel test lane) - [ ] npm package tests passing (`cd npm-package && npm run test:all`) - [ ] **Upgrade smoke tests pass** (`make test-upgrade`) — see [Release Stability Gate](engdocs/RELEASE-STABILITY-GATE.md) -- [ ] **Regression tests pass** (`make test-regression`) +- [ ] **Regression tests pass** + (`bazel test //tests/regression:regression_test --config=doltserver-cmd`) - [ ] **Every release target cross-compiles** — see [Cross-compile before tagging](#cross-compile-before-tagging). PR CI builds them only with cgo off, and a target that fails at tag time diff --git a/VERSIONED-BEADS-WRITE-PATHS.md b/VERSIONED-BEADS-WRITE-PATHS.md index 887816aad..bed384ade 100644 --- a/VERSIONED-BEADS-WRITE-PATHS.md +++ b/VERSIONED-BEADS-WRITE-PATHS.md @@ -19,7 +19,7 @@ Row numbers are the historical table's. Line numbers in this table are against t | # | Path | Version seam at this head | Disposition | Mechanism | |---|---|---|---|---| -| 13 | any of rows 1-8 whose target row is a wisp **or a promoted no-history bead** | no | NO-OP | `RecordVersionInTx` returns on `IsWisp`, which is `Ephemeral \|\| NoHistory` (helpers.go:36-41): wisps per FR-8, and a promoted no-history bead — a durable issues-plane row with `NoHistory=true` — because no-history means no history. Wording only; the code did not change. | +| 13 | any of rows 1-8 whose target row is a wisp **or a promoted no-history bead** | no | NO-OP (a flagged issues-table create is stamped, not versioned) | The table that holds the row decides its plane, not its flags. A row in the wisps table mints and stamps nothing, whatever its flags say (FR-8). An update-shaped call on a flagged wisp returns on `IsWisp`, which is `Ephemeral \|\| NoHistory` (helpers.go:36-41). Every other wisps-table row is excluded by the seam's read of `participation_generation` from the issues table, which finds no row and returns: a flagged wisp's create-shaped call, and an unflagged row (bd mol squash's in-place flag clear, import's `wisp_plane` marker), which passes `IsWisp`. An issues-table row carrying `NoHistory` (a promoted no-history bead, bd-r9uce) is never versioned while it says so, because no-history means no history: an update-shaped call returns on `IsWisp`. A create-shaped call on such a row, with the flag on, still stamps `participation_generation` and mints nothing, so the row is not legacy once `bd update --persistent` repairs the flag in place. | | 14 | dependencies.go:`addDependencyInTx` via `AddDependencyInTx` from the store verbs, `ApplyParentPatch`, `applyBatchRun.applyDepAdd` | yes | VERSIONED | mint moved into `addDependencyInTx` (`mintDependencyVersion`, dependencies.go:393), gated on the row insert rather than on `eventWritten`; the publicops editor's own mint call was removed so no leg double-mints | | 15 | domain/db/dependency.go:`dependencySQLRepositoryImpl.Insert` (uow `AddDependencies`, create-time edges) | yes | VERSIONED | seam at dependency.go:228 and :240 after the insert | | 16 | dependencies.go:`removeDependencyInTx` via `RemoveDependencyInTx` and domain/db/dependency.go:`Delete` | yes | VERSIONED | gated on the row delete; dependency.go:409 on the uow leg | diff --git a/backend/conformance/BUILD.bazel b/backend/conformance/BUILD.bazel index 128d7ca97..2ba90b30b 100644 --- a/backend/conformance/BUILD.bazel +++ b/backend/conformance/BUILD.bazel @@ -11,9 +11,11 @@ go_library( "audit_molecule_wisp_batch_iter.go", "audit_search-counts-stats.go", "batch_apply_contract.go", + "batch_apply_gate_contract.go", "batch_closer_contract.go", "batch_creator_contract.go", "batch_getter_contract.go", + "blocked_lister_contract.go", "blocked_state.go", "blocking_annotator_contract.go", "bootstrapper_contract.go", @@ -27,9 +29,11 @@ go_library( "deleter_contract.go", "dependency_editor_contract.go", "dualwrite_history_contract.go", + "dualwrite_participation_generation_contract.go", "edge_reader_contract.go", "expected_revision_contract.go", "graph_counter_contract.go", + "heartbeater_contract.go", "history_matching.go", "importer_contract.go", "issue_operations_contract.go", @@ -38,7 +42,9 @@ go_library( "lease_reclaimer_contract.go", "lifecycle_close_reopen_contract.go", "lifecycle_create_contract.go", + "lifecycle_create_gate_contract.go", "lifecycle_update_contract.go", + "lifecycle_update_gate_contract.go", "memories_contract.go", "metadata_cas_contract.go", "molecule_contract.go", @@ -59,6 +65,7 @@ go_library( "transaction_parity.go", "tree_walker_contract.go", "version_reconciler_contract.go", + "versioned_read_contract.go", "workspaceconfig_contract.go", ], importpath = "github.com/steveyegge/beads/backend/conformance", diff --git a/backend/conformance/batch_apply_gate_contract.go b/backend/conformance/batch_apply_gate_contract.go new file mode 100644 index 000000000..c38689461 --- /dev/null +++ b/backend/conformance/batch_apply_gate_contract.go @@ -0,0 +1,145 @@ +package conformance + +import ( + "context" + "encoding/json" + "errors" + "slices" + "testing" + "time" + + "github.com/steveyegge/beads/internal/types" + publicops "github.com/steveyegge/beads/issueops" +) + +// The BatchApplier half of the gate-member clauses; see +// lifecycle_create_gate_contract.go. + +// RunBatchApplyCarriesTheGateMembers pins the gate members through +// BatchApplier: a create item stores all four, an update item replaces the +// waiter list of an existing row whole, a clear through an update item stores +// the empty list `[]`, and a create or update item past a bound refuses the +// WHOLE request as ErrValidation naming its member (on its *ItemError for the +// update item), so the earlier item rolls back with it. +func RunBatchApplyCarriesTheGateMembers(t *testing.T, ctx context.Context, fixture BatchApplyFixture) { + t.Helper() + + gate := fixture.IssuePrefix + "-bag-gate" + existing := fixture.IssuePrefix + "-bag-existing" + batchApplySeedIssue(t, ctx, fixture, existing, types.StatusOpen) + + issue := batchApplyIssue(gate, "a gate made by a plan") + issue.IssueType = types.TypeGate + issue.AwaitType = "timer" + issue.AwaitID = "await-plan" + issue.Timeout = 2 * time.Hour + issue.Waiters = []string{"a", "a", "b"} + batchApplyMust(t, ctx, fixture, publicops.ApplyBatchRequest{ + Actor: "apply-writer", + ForceIDPrefix: true, + Items: []publicops.ApplyItem{ + batchApplyCreate("gate", issue), + batchApplyUpdate(publicops.Ref{ID: existing}, publicops.IssuePatch{ + AwaitID: publicops.Field[string]{Set: true, Value: "bead:" + gate}, + Waiters: publicops.Field[[]string]{Set: true, Value: []string{"x", "y"}}, + }), + }, + }) + assertBatchApplyGateColumns(t, ctx, fixture, gate, "timer", "await-plan", 2*time.Hour, []string{"a", "a", "b"}) + assertBatchApplyGateColumns(t, ctx, fixture, existing, "", "bead:"+gate, 0, []string{"x", "y"}) + + // A clear through an update item stores the empty JSON list, not NULL and + // not the JSON null: the column is read raw here because every reader + // above treats the three alike. + batchApplyMust(t, ctx, fixture, publicops.ApplyBatchRequest{ + Actor: "apply-writer", + Items: []publicops.ApplyItem{ + batchApplyUpdate(publicops.Ref{ID: existing}, publicops.IssuePatch{ + AwaitID: publicops.Field[string]{Set: true}, + Waiters: publicops.Field[[]string]{Set: true}, + }), + }, + }) + assertBatchApplyGateColumns(t, ctx, fixture, existing, "", "", 0, nil) + var clearedWaiters string + if err := fixture.QueryScalar(ctx, "SELECT COALESCE(waiters, '') FROM issues WHERE id = ?", []any{existing}, &clearedWaiters); err != nil { + t.Fatalf("read the waiters column of %s: %v", existing, err) + } + if clearedWaiters != "[]" { + t.Errorf("%s waiters column after a clear = %q, want the stored empty list %q", existing, clearedWaiters, "[]") + } + + first := fixture.IssuePrefix + "-bag-rolledback" + refused := batchApplyIssue(fixture.IssuePrefix+"-bag-refused", "past the bound") + refused.AwaitType = gateFieldAtBoundAwaitType + "x" + _, err := fixture.BatchApplier.ApplyBatch(ctx, publicops.ApplyBatchRequest{ + Actor: "apply-writer", + ForceIDPrefix: true, + Items: []publicops.ApplyItem{ + batchApplyCreate("first", batchApplyIssue(first, "rolls back with the refusal")), + batchApplyCreate("refused", refused), + }, + }) + assertGateFieldError(t, err, "a create item with await_type past its bound", publicops.GateFieldAwaitType) + assertBatchApplyRowCount(t, ctx, fixture, "issues", first, 0) + + // An update item past a bound refuses the same way, named on its own + // item: the earlier create rolls back, and the target keeps its columns. + firstOfUpdate := fixture.IssuePrefix + "-bag-rolledback-upd" + _, err = fixture.BatchApplier.ApplyBatch(ctx, publicops.ApplyBatchRequest{ + Actor: "apply-writer", + ForceIDPrefix: true, + Items: []publicops.ApplyItem{ + batchApplyCreate("first", batchApplyIssue(firstOfUpdate, "rolls back with the refusal")), + batchApplyUpdate(publicops.Ref{ID: gate}, publicops.IssuePatch{ + Title: publicops.Field[string]{Set: true, Value: "must not land"}, + AwaitID: publicops.Field[string]{Set: true, Value: gateFieldAtBoundAwaitID + "x"}, + }), + }, + }) + assertGateFieldError(t, err, "an update item with await_id past its bound", publicops.GateFieldAwaitID) + var itemErr *publicops.ItemError + if !errors.As(err, &itemErr) { + t.Fatalf("an update item with await_id past its bound: error = %v, want an *ItemError naming the item", err) + } + if itemErr.Index != 1 || itemErr.Kind != publicops.ItemUpdate { + t.Errorf("ItemError = %#v, want Index 1 and Kind %q", itemErr, publicops.ItemUpdate) + } + assertBatchApplyRowCount(t, ctx, fixture, "issues", firstOfUpdate, 0) + assertBatchApplyGateColumns(t, ctx, fixture, gate, "timer", "await-plan", 2*time.Hour, []string{"a", "a", "b"}) + if got := batchApplyColumn(t, ctx, fixture, "title", gate); got != "a gate made by a plan" { + t.Errorf("%s title = %q, want the created title: a refused item writes nothing", gate, got) + } +} + +// assertBatchApplyGateColumns reads the four gate columns of one durable row +// raw, so neither side of the comparison comes from the role. +func assertBatchApplyGateColumns(t *testing.T, ctx context.Context, fixture BatchApplyFixture, id, awaitType, awaitID string, timeout time.Duration, waiters []string) { + t.Helper() + var gotType, gotID, gotWaiters string + var gotTimeout int64 + if err := fixture.QueryScalar(ctx, + "SELECT COALESCE(await_type, ''), COALESCE(await_id, ''), COALESCE(timeout_ns, 0), COALESCE(waiters, '') FROM issues WHERE id = ?", + []any{id}, &gotType, &gotID, &gotTimeout, &gotWaiters); err != nil { + t.Fatalf("read the gate columns of %s: %v", id, err) + } + if gotType != awaitType || gotID != awaitID || time.Duration(gotTimeout) != timeout { + t.Errorf("%s gate columns = (%q, %q, %s), want (%q, %q, %s)", id, gotType, gotID, time.Duration(gotTimeout), awaitType, awaitID, timeout) + } + if stored := parseGateWaiters(gotWaiters); !slices.Equal(stored, waiters) { + t.Errorf("%s waiters column = %q (%q), want %q", id, gotWaiters, stored, waiters) + } +} + +// parseGateWaiters reads the waiters TEXT column's JSON array, treating the +// empty string, `null` and `[]` as the one empty list they all mean. +func parseGateWaiters(raw string) []string { + if raw == "" || raw == "null" || raw == "[]" { + return nil + } + var out []string + if err := json.Unmarshal([]byte(raw), &out); err != nil { + return []string{""} + } + return out +} diff --git a/backend/conformance/blocked_lister_contract.go b/backend/conformance/blocked_lister_contract.go new file mode 100644 index 000000000..9313e3e76 --- /dev/null +++ b/backend/conformance/blocked_lister_contract.go @@ -0,0 +1,426 @@ +package conformance + +import ( + "context" + "fmt" + "reflect" + "slices" + "testing" + "time" + + "github.com/steveyegge/beads/internal/types" + publicops "github.com/steveyegge/beads/issueops" +) + +// This file holds the semantic contract every implementation of +// publicops.BlockedLister must satisfy: what issueops/blockedlister.go +// promises, asserted on every leg (dolt, embedded dolt, unit of work, and the +// served HTTP client) so `bd blocked` answers one listing whichever route it +// takes. +// +// EVERY CASE IS SCOPED BY A LABEL: the blocked set is a property of the whole +// database, not of an id prefix, so a row seeded by one case is inside the +// next one's answer unless each asks through Labels. + +// BlockedListerFixture supplies adapter-specific storage access for the +// blocked-listing assertions. +type BlockedListerFixture struct { + // IssuePrefix namespaces the ids each case seeds, so several cases can + // share one database. + IssuePrefix string + // BlockedLister is the surface under test. + BlockedLister publicops.BlockedLister + // CreateIssue seeds a durable issue in the issues plane. + CreateIssue func(context.Context, *types.Issue, string) error + // CreateWisp seeds an ephemeral issue in the wisps plane. + CreateWisp func(context.Context, *types.Issue, string) error + // AddDependency seeds ONE edge, recomputing the stored blocked flag the + // way every dependency write does. + AddDependency func(context.Context, *types.Dependency, string) error + // MarkBlocked sets the stored is_blocked flag on one durable issue + // directly, without the edge that would justify it: the stale flag `bd + // recompute-blocked` exists to repair. It must fail unless exactly one row + // changed. A nil hook means this leg cannot write the column, and the case + // that needs it skips with that reason. + MarkBlocked func(context.Context, string) error +} + +// RunBlockedLister runs every blocked-listing case as a subtest of t. +func RunBlockedLister(t *testing.T, ctx context.Context, fixture BlockedListerFixture) { + t.Helper() + t.Run("NamesADirectBlocker", func(t *testing.T) { runBlockedNamesADirectBlocker(t, ctx, fixture) }) + t.Run("AttributesAChildToItsBlockedParent", func(t *testing.T) { runBlockedAttributesAChildToItsParent(t, ctx, fixture) }) + t.Run("ClosedBlockerDoesNotBlock", func(t *testing.T) { runBlockedClosedBlockerDoesNotBlock(t, ctx, fixture) }) + t.Run("IncludesTheWispPlane", func(t *testing.T) { runBlockedIncludesTheWispPlane(t, ctx, fixture) }) + t.Run("ExcludesThePinnedStatus", func(t *testing.T) { runBlockedExcludesThePinnedStatus(t, ctx, fixture) }) + t.Run("ParentFilter", func(t *testing.T) { runBlockedParentFilter(t, ctx, fixture) }) + t.Run("LabelFilters", func(t *testing.T) { runBlockedLabelFilters(t, ctx, fixture) }) + t.Run("Order", func(t *testing.T) { runBlockedOrder(t, ctx, fixture) }) + t.Run("NamesWaitsForAndConditionalBlockers", func(t *testing.T) { runBlockedNamesWaitsForAndConditionalBlockers(t, ctx, fixture) }) + t.Run("OmitsAStaleFlagWithNoNameableBlocker", func(t *testing.T) { runBlockedOmitsAStaleFlag(t, ctx, fixture) }) + t.Run("HasNoTypeExclusions", func(t *testing.T) { runBlockedHasNoTypeExclusions(t, ctx, fixture) }) + t.Run("EmptyIsAnEmptySlice", func(t *testing.T) { runBlockedEmptyIsAnEmptySlice(t, ctx, fixture) }) + t.Run("DoesNotMutateTheCallerRequest", func(t *testing.T) { runBlockedDoesNotMutateTheRequest(t, ctx, fixture) }) +} + +// runBlockedNamesADirectBlocker: an issue with an open `blocks` target is +// listed with that target as its one blocker; the target itself is not. +func runBlockedNamesADirectBlocker(t *testing.T, ctx context.Context, f BlockedListerFixture) { + label := f.IssuePrefix + "-bl-direct" + blocked, blocker := blListerID(f, "direct-src"), blListerID(f, "direct-dst") + blListerSeedIssue(t, ctx, f, blListerIssue(blocked, 1, label)) + blListerSeedIssue(t, ctx, f, blListerIssue(blocker, 1, label)) + blListerSeedEdge(t, ctx, f, blocked, blocker, types.DepBlocks) + + items := blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{label}}) + blListerAssertRows(t, items, map[string][]string{blocked: {blocker}}) +} + +// runBlockedAttributesAChildToItsParent: a child of a blocked parent, with no +// blocker of its own, is listed with its parent named as the blocker. +func runBlockedAttributesAChildToItsParent(t *testing.T, ctx context.Context, f BlockedListerFixture) { + label := f.IssuePrefix + "-bl-child" + parent, child, blocker := blListerID(f, "child-parent"), blListerID(f, "child-child"), blListerID(f, "child-blocker") + blListerSeedIssue(t, ctx, f, blListerIssue(parent, 1, label)) + blListerSeedIssue(t, ctx, f, blListerIssue(blocker, 1, label+"-other")) + blListerSeedIssue(t, ctx, f, blListerIssue(child, 1, label)) + blListerSeedEdge(t, ctx, f, child, parent, types.DepParentChild) + blListerSeedEdge(t, ctx, f, parent, blocker, types.DepBlocks) + + items := blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{label}}) + blListerAssertRows(t, items, map[string][]string{parent: {blocker}, child: {parent}}) +} + +// runBlockedClosedBlockerDoesNotBlock: a `blocks` edge onto a closed target +// names no blocker, so the source is not listed. +func runBlockedClosedBlockerDoesNotBlock(t *testing.T, ctx context.Context, f BlockedListerFixture) { + label := f.IssuePrefix + "-bl-closed" + src, dst := blListerID(f, "closed-src"), blListerID(f, "closed-dst") + blListerSeedIssue(t, ctx, f, blListerIssue(src, 1, label)) + closed := blListerIssue(dst, 1, label) + closed.Status = types.StatusClosed + blListerSeedIssue(t, ctx, f, closed) + blListerSeedEdge(t, ctx, f, src, dst, types.DepBlocks) + + items := blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{label}}) + blListerAssertRows(t, items, map[string][]string{}) +} + +// runBlockedIncludesTheWispPlane: a blocked wisp is listed beside the issues. +func runBlockedIncludesTheWispPlane(t *testing.T, ctx context.Context, f BlockedListerFixture) { + label := f.IssuePrefix + "-bl-wisp" + wisp, blocker := blListerID(f, "wisp-src"), blListerID(f, "wisp-dst") + w := blListerIssue(wisp, 1, label) + w.Ephemeral = true + if err := f.CreateWisp(ctx, w, "seed"); err != nil { + t.Fatalf("seed wisp %s: %v", wisp, err) + } + b := blListerIssue(blocker, 1, label) + b.Ephemeral = true + if err := f.CreateWisp(ctx, b, "seed"); err != nil { + t.Fatalf("seed wisp %s: %v", blocker, err) + } + blListerSeedEdge(t, ctx, f, wisp, blocker, types.DepBlocks) + + items := blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{label}}) + blListerAssertRows(t, items, map[string][]string{wisp: {blocker}}) +} + +// runBlockedExcludesThePinnedStatus: a row whose status is pinned is never +// listed, whatever blocks it. +func runBlockedExcludesThePinnedStatus(t *testing.T, ctx context.Context, f BlockedListerFixture) { + label := f.IssuePrefix + "-bl-pinned" + pinned, open, blocker := blListerID(f, "pinned-src"), blListerID(f, "pinned-open"), blListerID(f, "pinned-dst") + p := blListerIssue(pinned, 1, label) + p.Status = types.StatusPinned + blListerSeedIssue(t, ctx, f, p) + blListerSeedIssue(t, ctx, f, blListerIssue(open, 1, label)) + blListerSeedIssue(t, ctx, f, blListerIssue(blocker, 1, label+"-other")) + blListerSeedEdge(t, ctx, f, pinned, blocker, types.DepBlocks) + blListerSeedEdge(t, ctx, f, open, blocker, types.DepBlocks) + + items := blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{label}}) + blListerAssertRows(t, items, map[string][]string{open: {blocker}}) +} + +// runBlockedParentFilter: ParentID narrows to the parent's direct children. +func runBlockedParentFilter(t *testing.T, ctx context.Context, f BlockedListerFixture) { + label := f.IssuePrefix + "-bl-parent" + parent, kid, stranger, blocker := blListerID(f, "pf-parent"), blListerID(f, "pf-kid"), blListerID(f, "pf-stranger"), blListerID(f, "pf-blocker") + blListerSeedIssue(t, ctx, f, blListerIssue(parent, 1, label+"-other")) + blListerSeedIssue(t, ctx, f, blListerIssue(blocker, 1, label+"-other")) + blListerSeedIssue(t, ctx, f, blListerIssue(kid, 1, label)) + blListerSeedIssue(t, ctx, f, blListerIssue(stranger, 1, label)) + blListerSeedEdge(t, ctx, f, kid, parent, types.DepParentChild) + blListerSeedEdge(t, ctx, f, kid, blocker, types.DepBlocks) + blListerSeedEdge(t, ctx, f, stranger, blocker, types.DepBlocks) + + all := blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{label}}) + blListerAssertRows(t, all, map[string][]string{kid: {blocker}, stranger: {blocker}}) + narrowed := blListerList(t, ctx, f, publicops.BlockedRequest{ParentID: parent, Labels: []string{label}}) + blListerAssertRows(t, narrowed, map[string][]string{kid: {blocker}}) +} + +// runBlockedLabelFilters: Labels is AND, LabelsAny is OR, ExcludeLabels +// removes, and every value is trimmed with blanks dropped. +func runBlockedLabelFilters(t *testing.T, ctx context.Context, f BlockedListerFixture) { + base := f.IssuePrefix + "-bl-lab" + red, blue := base+"-red", base+"-blue" + both, onlyRed, onlyBlue, blocker := blListerID(f, "lab-both"), blListerID(f, "lab-red"), blListerID(f, "lab-blue"), blListerID(f, "lab-blocker") + blListerSeedIssue(t, ctx, f, blListerIssue(both, 1, base, red, blue)) + blListerSeedIssue(t, ctx, f, blListerIssue(onlyRed, 1, base, red)) + blListerSeedIssue(t, ctx, f, blListerIssue(onlyBlue, 1, base, blue)) + blListerSeedIssue(t, ctx, f, blListerIssue(blocker, 1, base+"-other")) + for _, id := range []string{both, onlyRed, onlyBlue} { + blListerSeedEdge(t, ctx, f, id, blocker, types.DepBlocks) + } + want := func(ids ...string) map[string][]string { + m := map[string][]string{} + for _, id := range ids { + m[id] = []string{blocker} + } + return m + } + + blListerAssertRows(t, blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{" " + red + " ", "", blue}}), want(both)) + blListerAssertRows(t, blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{base}, LabelsAny: []string{red, blue}}), want(both, onlyRed, onlyBlue)) + blListerAssertRows(t, blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{base}, ExcludeLabels: []string{" " + blue}}), want(onlyRed)) +} + +// runBlockedOrder: priority ascending, then created_at descending, then id. +// +// The created_at values are seeded explicitly, so every key decides at least +// one pair: two rows share a priority and differ in created_at (newest first), +// and five share both priority and created_at (the id breaks the tie). The +// expected order is written out rather than recomputed from the answer. +func runBlockedOrder(t *testing.T, ctx context.Context, f BlockedListerFixture) { + label := f.IssuePrefix + "-bl-order" + blocker := blListerID(f, "order-blocker") + blListerSeedIssue(t, ctx, f, blListerIssue(blocker, 1, label+"-other")) + older := time.Date(2026, 1, 1, 10, 0, 0, 0, time.UTC) + newer := older.Add(time.Hour) + // Two of the five tied rows are wisps. The store body assembles rows + // issues-plane first, each plane in id order, so the ids alone would put + // the tied run in the wrong order (b, d, e, then a, c); only the id + // tiebreak puts it right. + rows := []struct { + name string + priority int + created time.Time + wisp bool + }{ + {"order-p3", 3, newer, false}, + {"order-p0-older", 0, older, false}, + {"order-p0-newer-e", 0, newer, false}, + {"order-p0-newer-c", 0, newer, true}, + {"order-p0-newer-a", 0, newer, true}, + {"order-p0-newer-d", 0, newer, false}, + {"order-p0-newer-b", 0, newer, false}, + {"order-p1", 1, older, false}, + } + for _, row := range rows { + issue := blListerIssue(blListerID(f, row.name), row.priority, label) + issue.CreatedAt = row.created + issue.UpdatedAt = row.created + if row.wisp { + issue.Ephemeral = true + if err := f.CreateWisp(ctx, issue, "seed"); err != nil { + t.Fatalf("seed wisp %s: %v", issue.ID, err) + } + } else { + blListerSeedIssue(t, ctx, f, issue) + } + blListerSeedEdge(t, ctx, f, issue.ID, blocker, types.DepBlocks) + } + want := []string{ + blListerID(f, "order-p0-newer-a"), + blListerID(f, "order-p0-newer-b"), + blListerID(f, "order-p0-newer-c"), + blListerID(f, "order-p0-newer-d"), + blListerID(f, "order-p0-newer-e"), + blListerID(f, "order-p0-older"), + blListerID(f, "order-p1"), + blListerID(f, "order-p3"), + } + got := blListerIDs(blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{label}})) + if !slices.Equal(got, want) { + t.Errorf("listing order = %v, want %v (priority ascending, created_at descending, id)", got, want) + } +} + +// runBlockedNamesWaitsForAndConditionalBlockers: a waits-for onto a spawner +// whose child is still open, and a conditional-blocks onto an open target, +// each name their target, as a blocks edge does. +func runBlockedNamesWaitsForAndConditionalBlockers(t *testing.T, ctx context.Context, f BlockedListerFixture) { + label := f.IssuePrefix + "-bl-wf" + spawner, spawned := blListerID(f, "wf-spawner"), blListerID(f, "wf-spawned") + waiter := blListerID(f, "wf-waiter") + target, conditional := blListerID(f, "cb-target"), blListerID(f, "cb-src") + blListerSeedIssue(t, ctx, f, blListerIssue(spawner, 1, label+"-other")) + blListerSeedIssue(t, ctx, f, blListerIssue(spawned, 1, label+"-other")) + blListerSeedIssue(t, ctx, f, blListerIssue(target, 1, label+"-other")) + blListerSeedIssue(t, ctx, f, blListerIssue(waiter, 1, label)) + blListerSeedIssue(t, ctx, f, blListerIssue(conditional, 1, label)) + blListerSeedEdge(t, ctx, f, spawned, spawner, types.DepParentChild) + blListerSeedEdge(t, ctx, f, waiter, spawner, types.DepWaitsFor) + blListerSeedEdge(t, ctx, f, conditional, target, types.DepConditionalBlocks) + + items := blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{label}}) + blListerAssertRows(t, items, map[string][]string{waiter: {spawner}, conditional: {target}}) +} + +// runBlockedOmitsAStaleFlag: a row whose stored flag says blocked but which +// has no active blocker and no parent names no blocker, so it is not listed. +// This is the narrowing gc's readiness projection documents relying on. +func runBlockedOmitsAStaleFlag(t *testing.T, ctx context.Context, f BlockedListerFixture) { + if f.MarkBlocked == nil { + t.Skip("this leg cannot write the stored is_blocked flag directly") + } + label := f.IssuePrefix + "-bl-stale" + stale, real, blocker := blListerID(f, "stale-src"), blListerID(f, "stale-real"), blListerID(f, "stale-blocker") + blListerSeedIssue(t, ctx, f, blListerIssue(stale, 1, label)) + blListerSeedIssue(t, ctx, f, blListerIssue(real, 1, label)) + blListerSeedIssue(t, ctx, f, blListerIssue(blocker, 1, label+"-other")) + blListerSeedEdge(t, ctx, f, real, blocker, types.DepBlocks) + if err := f.MarkBlocked(ctx, stale); err != nil { + t.Fatalf("mark %s blocked: %v", stale, err) + } + + items := blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{label}}) + blListerAssertRows(t, items, map[string][]string{real: {blocker}}) +} + +// runBlockedHasNoTypeExclusions: a gate is listed like any other row; the +// blocked door excludes no issue type (unlike the ready front). +func runBlockedHasNoTypeExclusions(t *testing.T, ctx context.Context, f BlockedListerFixture) { + label := f.IssuePrefix + "-bl-type" + gate, epic, blocker := blListerID(f, "type-gate"), blListerID(f, "type-epic"), blListerID(f, "type-blocker") + g := blListerIssue(gate, 1, label) + g.IssueType = types.TypeGate + g.AwaitType = "human" + blListerSeedIssue(t, ctx, f, g) + e := blListerIssue(epic, 1, label) + e.IssueType = types.TypeEpic + blListerSeedIssue(t, ctx, f, e) + blListerSeedIssue(t, ctx, f, blListerIssue(blocker, 1, label+"-other")) + blListerSeedEdge(t, ctx, f, gate, blocker, types.DepBlocks) + blListerSeedEdge(t, ctx, f, epic, blocker, types.DepBlocks) + + items := blListerList(t, ctx, f, publicops.BlockedRequest{Labels: []string{label}}) + blListerAssertRows(t, items, map[string][]string{gate: {blocker}, epic: {blocker}}) +} + +// runBlockedEmptyIsAnEmptySlice: nothing blocked is an empty, non-nil slice +// and a nil error. +func runBlockedEmptyIsAnEmptySlice(t *testing.T, ctx context.Context, f BlockedListerFixture) { + result, err := f.BlockedLister.ListBlocked(ctx, publicops.BlockedRequest{Labels: []string{f.IssuePrefix + "-bl-nothing"}}) + if err != nil { + t.Fatalf("ListBlocked: %v", err) + } + if result.Items == nil || len(result.Items) != 0 { + t.Fatalf("Items = %#v, want an empty non-nil slice", result.Items) + } +} + +// runBlockedDoesNotMutateTheRequest: the caller's label slices come back as +// they were sent, normalization notwithstanding. +func runBlockedDoesNotMutateTheRequest(t *testing.T, ctx context.Context, f BlockedListerFixture) { + req := publicops.BlockedRequest{ + ParentID: " ", + Labels: []string{" a ", "", "a"}, + LabelsAny: []string{" b"}, + ExcludeLabels: []string{"c "}, + } + before := publicops.BlockedRequest{ + ParentID: req.ParentID, + Labels: slices.Clone(req.Labels), + LabelsAny: slices.Clone(req.LabelsAny), + ExcludeLabels: slices.Clone(req.ExcludeLabels), + } + if _, err := f.BlockedLister.ListBlocked(ctx, req); err != nil { + t.Fatalf("ListBlocked: %v", err) + } + if !reflect.DeepEqual(req, before) { + t.Errorf("request after = %#v, before = %#v", req, before) + } +} + +func blListerID(f BlockedListerFixture, name string) string { + return fmt.Sprintf("%s-%s", f.IssuePrefix, name) +} + +func blListerIssue(id string, priority int, labels ...string) *types.Issue { + return &types.Issue{ + ID: id, + Title: id, + Status: types.StatusOpen, + Priority: priority, + IssueType: types.TypeTask, + Labels: labels, + } +} + +func blListerSeedIssue(t *testing.T, ctx context.Context, f BlockedListerFixture, issue *types.Issue) { + t.Helper() + if err := f.CreateIssue(ctx, issue, "seed"); err != nil { + t.Fatalf("seed issue %s: %v", issue.ID, err) + } +} + +func blListerSeedEdge(t *testing.T, ctx context.Context, f BlockedListerFixture, from, to string, kind types.DependencyType) { + t.Helper() + if err := f.AddDependency(ctx, &types.Dependency{IssueID: from, DependsOnID: to, Type: kind}, "seed"); err != nil { + t.Fatalf("seed %s edge %s -> %s: %v", kind, from, to, err) + } +} + +func blListerList(t *testing.T, ctx context.Context, f BlockedListerFixture, req publicops.BlockedRequest) []*types.BlockedIssue { + t.Helper() + result, err := f.BlockedLister.ListBlocked(ctx, req) + if err != nil { + t.Fatalf("ListBlocked(%+v): %v", req, err) + } + if result.Items == nil { + t.Fatalf("ListBlocked(%+v) Items is nil; the role promises a non-nil slice", req) + } + return result.Items +} + +func blListerIDs(items []*types.BlockedIssue) []string { + ids := make([]string, 0, len(items)) + for _, item := range items { + ids = append(ids, item.ID) + } + return ids +} + +// assertBlockedRows requires the listing to be exactly want: the same ids, +// each naming exactly the blockers want gives it (in any order), with +// BlockedByCount equal to their number. +func blListerAssertRows(t *testing.T, items []*types.BlockedIssue, want map[string][]string) { + t.Helper() + got := map[string][]string{} + for _, item := range items { + if item == nil { + t.Fatalf("listing carries a nil row") + } + if _, dup := got[item.ID]; dup { + t.Errorf("row %s listed twice", item.ID) + } + blockers := slices.Clone(item.BlockedBy) + slices.Sort(blockers) + got[item.ID] = blockers + if item.BlockedByCount != len(item.BlockedBy) { + t.Errorf("row %s: BlockedByCount = %d, len(BlockedBy) = %d", item.ID, item.BlockedByCount, len(item.BlockedBy)) + } + } + normalized := map[string][]string{} + for id, blockers := range want { + b := slices.Clone(blockers) + slices.Sort(b) + normalized[id] = b + } + if !reflect.DeepEqual(got, normalized) { + t.Errorf("listing = %v, want %v", got, normalized) + } +} diff --git a/backend/conformance/dualwrite_history_contract.go b/backend/conformance/dualwrite_history_contract.go index 8bfb55c56..e94a15d01 100644 --- a/backend/conformance/dualwrite_history_contract.go +++ b/backend/conformance/dualwrite_history_contract.go @@ -71,11 +71,13 @@ import ( // - PARTICIPATION-GENERATION GATING (design §16.2b). Whether an // update-shaped mutation on a legacy (participation_generation IS NULL) // row is correctly skipped is Phase 2 behavior this bead also owns, but -// it depends on migration 0068's participation_generation column, which -// does not exist when this contract is first written (0068 lands last in -// this bead's build order, by the mayor's explicit sequencing). It gets -// its own dedicated cases once 0068 lands, beside this file rather than -// inside it. +// it depends on migration 0070's participation_generation column, which +// does not exist when this contract is first written (0070 lands last in +// this bead's build order, by the mayor's explicit sequencing — steps 4-5 +// of design §16.3 moved to their own migration slot when 0068 shipped as +// attribution_status-only, see that migration's header). It gets its own +// dedicated cases once 0070 lands, beside this file rather than inside +// it. // - CONCURRENT WRITERS. Every case here is one writer, one issue, one // mutation at a time — the same restriction journal_contract.go states // for the same reason: a single-threaded case cannot exercise what only diff --git a/backend/conformance/dualwrite_participation_generation_contract.go b/backend/conformance/dualwrite_participation_generation_contract.go new file mode 100644 index 000000000..7943e7e4a --- /dev/null +++ b/backend/conformance/dualwrite_participation_generation_contract.go @@ -0,0 +1,644 @@ +package conformance + +import ( + "context" + "testing" +) + +// This file holds the write-fence cases dualwrite_history_contract.go's own +// "WHAT THIS CONTRACT DELIBERATELY DOES NOT PIN" section explicitly deferred: +// "PARTICIPATION-GENERATION GATING (design §16.2b)... It gets its own +// dedicated cases once 0070 lands, beside this file rather than inside it." +// Migration 0070 now carries participation_generation on both issues and +// wisps (design §16.3 steps 4-5, be-dt74u amendment, be-h89oq), so this is +// that file. +// +// Design §16.2b, verbatim substance: the flag-on writer does not increment +// current_revision or mint an issue_versions row for an UPDATE-shaped +// mutation against a record whose participation_generation is NULL — a skip, +// not a refusal (FR-2's zero-rows no-op shape). A CREATE-shaped mutation is +// different: a brand-new row has no prior legacy state to preserve, so if the +// flag is already on at creation time, the writer stamps +// participation_generation as part of the same insert that begins its +// history. A create with the flag off leaves the column NULL, indistinguishable +// from a true legacy row (FR-7's byte-identical requirement). +// +// WHY A SEPARATE FIXTURE RATHER THAN THREE MORE DualWriteFixture CLOSURES. +// DualWriteFixture's Mutate/MutateAsNoOp pair is deliberately flag-fixed-at- +// construction (see that file's SEEDING DISCIPLINE note and each leg's +// newXxxDualWriteFixture, which calls SetVersionedHistoryEnabled exactly +// once). The legacy-record case here is inherently "created while the flag +// was OFF, then mutated after the flag turns ON" — a fixture built once with +// one flag state cannot express that sequence, so SetFlag here is a toggle +// callable more than once per fixture, not a one-time constructor argument. +// +// THE FIXTURE'S CLOSURES ARE THE OBSERVABLE SURFACE, NOT THE SCHEMA — same +// discipline as DualWriteFixture: Mutate/MutateExisting drive CreateIssue and +// UpdateIssue (or their unit-of-work equivalents), never issue_versions or +// store_epoch directly. +// +// WHAT THIS CONTRACT DELIBERATELY DOES NOT PIN: +// - THE EXACT STAMPED VALUE. That a create-shaped mutation with the flag on +// stamps SOME non-NULL participation_generation is pinned here; that the +// value equals the current store_epoch.epoch is not — reaching +// store_epoch is the same one-column, two-of-three-legs-need-white-box- +// access problem dualwrite_history_contract.go's FR-6 note describes, and +// the same resolution applies: pinned per leg, dolt-only, alongside +// TestDualWriteStampsTheCurrentStoreEpochOnEachVersionRow. +// - wisps.participation_generation. FR-8 (carried by dualwrite_history_contract.go's +// exclusion list) applies here too: this fixture's Mutate front door is +// CreateIssue against the issues table, the wisp-arrival cases read only +// the issues row a wisp becomes, and no phase reads or writes the wisps +// column regardless. +type ParticipationGenerationFixture struct { + // IssuePrefix namespaces the id each case mints, the same discipline + // DualWriteFixture uses and for the same reason. + IssuePrefix string + // SetFlag toggles versioned history for every subsequent call through + // this fixture, and may be called more than once per case — unlike + // DualWriteFixture, whose flag is fixed at construction. + SetFlag func(ctx context.Context, enabled bool) error + // Mutate creates a new issue with the given id: a CREATE-shaped mutation + // in design §16.2b's sense. + Mutate func(ctx context.Context, id string) error + // MutateExisting applies a real (non-no-op) UPDATE-shaped mutation to an + // already-existing issue — a different value than Mutate gave it, so a + // vacuous no-op skip can never be mistaken for the fence. + MutateExisting func(ctx context.Context, id string) error + // CreateWisp creates a new wisp-plane (ephemeral) issue with the given + // id: the starting point for the two ways a record reaches the issues + // plane without being created there. A wisp is never versioned (FR-8) + // and never carries a participation declaration, in either flag state. + CreateWisp func(ctx context.Context, id string) error + // PromoteWisp promotes the wisp id onto the issues plane + // (PromoteFromEphemeral, or the unit-of-work leg's PromoteWisp). + PromoteWisp func(ctx context.Context, id string) error + // MovePersistent moves the wisp id onto the issues plane through a + // persistence-mode update (bd update --persistent). It is its own + // closure rather than a second spelling of PromoteWisp because it mints at + // a different site on every leg: the guarded update's one end-of-update + // mint on dolt and embeddeddolt, MoveIssuePersistenceInTx's own on uow. + // On an issues-plane row whose flags disagree with it (see + // CreateNoHistoryIssue) the same update repairs the flags in place, a + // same-plane normalize, rather than moving the row. + MovePersistent func(ctx context.Context, id string) error + // ClearWispFlag clears the wisp id's ephemeral flag IN PLACE: the untyped + // UpdateIssue of {"wisp": false} bd mol squash makes on a squashed root + // (UpdateWisp on the unit-of-work leg, the way its molecule writer routes + // it). The row stays in the wisps table, now carrying neither Ephemeral + // nor NoHistory. + ClearWispFlag func(ctx context.Context, id string) error + // SquashWispRoot closes the wisp id and then clears its flag as + // ClearWispFlag does, both in ONE transaction: the shape bd mol squash's + // root auto-close takes, where an error from either write aborts both. + SquashWispRoot func(ctx context.Context, id string) error + // CreateUnflaggedWisp creates id in the wisps table with neither + // Ephemeral nor NoHistory set: import's "wisp_plane" marker, which pins + // the plane whatever the flags say (WispPlaneOverride = &true, through + // the batch create import runs), or on the unit-of-work leg CreateWisp, + // which routes by the call rather than by the flags. + CreateUnflaggedWisp func(ctx context.Context, id string) error + // CreateNoHistoryIssue creates id in the ISSUES table carrying + // NoHistory=true: import's promoted-no-history shape (bd-r9uce), a + // durable row whose stray flag is preserved while WispPlaneOverride = + // &false pins its plane, through the batch create import runs; or on the + // unit-of-work leg CreateIssue, which routes by the call. + CreateNoHistoryIssue func(ctx context.Context, id string) error + // CurrentRevision reads issues.current_revision for id. + CurrentRevision func(ctx context.Context, id string) (int64, error) + // VersionRowCount reads how many issue_versions rows exist for id. + VersionRowCount func(ctx context.Context, id string) (int, error) + // ParticipationGeneration reads issues.participation_generation for id, + // returning nil for SQL NULL. + ParticipationGeneration func(ctx context.Context, id string) (*int64, error) + // InWispsTable reports whether the wisps table holds a row for id: the + // precondition the wisps-table cases check, so they cannot pass on a row + // that a step moved to the issues table. + InWispsTable func(ctx context.Context, id string) (bool, error) +} + +// RunParticipationGenerationCreateWithFlagOnStampsAValue pins design +// §16.2(a)/(b): a create-shaped mutation with the flag already on stamps a +// non-NULL participation_generation on the new row, as part of the same +// insert that begins its history — a brand-new row has no legacy state to +// preserve, so there is nothing to skip. +func RunParticipationGenerationCreateWithFlagOnStampsAValue(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + if err := fixture.SetFlag(ctx, true); err != nil { + t.Fatalf("enabling versioned history: %v", err) + } + id := fixture.IssuePrefix + "-create-stamps" + if err := fixture.Mutate(ctx, id); err != nil { + t.Fatalf("mutating %s: %v", id, err) + } + gen, err := fixture.ParticipationGeneration(ctx, id) + if err != nil { + t.Fatalf("reading participation_generation for %s: %v", id, err) + } + if gen == nil { + t.Errorf("participation_generation for %s is NULL immediately after a create-shaped mutation with "+ + "the flag on, want a stamped non-NULL value: design §16.2b requires the writer to declare "+ + "participation at insert time, since a brand-new row has no prior legacy state to preserve", id) + } +} + +// RunParticipationGenerationCreateWithFlagOffLeavesLegacyNull pins the other +// half of design §16.2(b): a create-shaped mutation with the flag off leaves +// participation_generation NULL, indistinguishable from a true legacy row — +// flag-off must stay byte-identical to pre-Phase-2 behavior (FR-7). +func RunParticipationGenerationCreateWithFlagOffLeavesLegacyNull(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + if err := fixture.SetFlag(ctx, false); err != nil { + t.Fatalf("disabling versioned history: %v", err) + } + id := fixture.IssuePrefix + "-create-flag-off" + if err := fixture.Mutate(ctx, id); err != nil { + t.Fatalf("mutating %s: %v", id, err) + } + gen, err := fixture.ParticipationGeneration(ctx, id) + if err != nil { + t.Fatalf("reading participation_generation for %s: %v", id, err) + } + if gen != nil { + t.Errorf("participation_generation for %s = %d with the flag off at creation, want NULL: a "+ + "flag-off create must remain indistinguishable from a true legacy row (design §16.2b)", id, *gen) + } +} + +// RunParticipationGenerationSkipsUpdateOnLegacyRecord pins the write fence's +// central claim, design §16.2(b): the flag-on writer does not increment +// current_revision or mint an issue_versions row for an update-shaped +// mutation against a record whose participation_generation is NULL. The +// record must be a REAL legacy record — created while the flag was off, not +// merely one the fixture asserts is NULL — so this also re-confirms that +// precondition before trusting the rest of the case. +func RunParticipationGenerationSkipsUpdateOnLegacyRecord(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + if err := fixture.SetFlag(ctx, false); err != nil { + t.Fatalf("disabling versioned history: %v", err) + } + id := fixture.IssuePrefix + "-legacy-skip" + if err := fixture.Mutate(ctx, id); err != nil { + t.Fatalf("mutating %s: %v", id, err) + } + if gen, err := fixture.ParticipationGeneration(ctx, id); err != nil { + t.Fatalf("reading participation_generation for %s: %v", id, err) + } else if gen != nil { + t.Fatalf("participation_generation for %s = %d before the flag was ever turned on, want NULL — "+ + "this case cannot test the legacy-record fence against a record that was never actually legacy", + id, *gen) + } + + if err := fixture.SetFlag(ctx, true); err != nil { + t.Fatalf("enabling versioned history: %v", err) + } + beforeRevision, err := fixture.CurrentRevision(ctx, id) + if err != nil { + t.Fatalf("reading current_revision for %s: %v", id, err) + } + beforeCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + + if err := fixture.MutateExisting(ctx, id); err != nil { + t.Fatalf("mutating existing %s: %v", id, err) + } + + afterRevision, err := fixture.CurrentRevision(ctx, id) + if err != nil { + t.Fatalf("reading current_revision for %s: %v", id, err) + } + afterCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + if afterCount != beforeCount { + t.Errorf("version row count for %s went from %d to %d across an update-shaped mutation on a "+ + "legacy (participation_generation IS NULL) record with the flag now on, want unchanged: "+ + "design §16.2b requires the writer to skip minting for a record it has not positively "+ + "promoted", id, beforeCount, afterCount) + } + if afterRevision != beforeRevision { + t.Errorf("current_revision for %s went from %d to %d across the same skipped mutation, want "+ + "unchanged: a skip means neither half of RecordVersionInTx's write runs, not just the "+ + "version-row half", id, beforeRevision, afterRevision) + } +} + +// RunParticipationGenerationProceedsForPromotedRecord is the fence's +// not-vacuous check: an update-shaped mutation against a record whose +// participation_generation is ALREADY stamped (created with the flag on, +// i.e. positively declared, not legacy) must mint normally. Without this +// case, an implementation that skips every update unconditionally would +// still pass RunParticipationGenerationSkipsUpdateOnLegacyRecord. +func RunParticipationGenerationProceedsForPromotedRecord(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + if err := fixture.SetFlag(ctx, true); err != nil { + t.Fatalf("enabling versioned history: %v", err) + } + id := fixture.IssuePrefix + "-promoted-proceeds" + if err := fixture.Mutate(ctx, id); err != nil { + t.Fatalf("mutating %s: %v", id, err) + } + if gen, err := fixture.ParticipationGeneration(ctx, id); err != nil { + t.Fatalf("reading participation_generation for %s: %v", id, err) + } else if gen == nil { + t.Fatalf("participation_generation for %s is NULL immediately after a create with the flag on — "+ + "this case cannot test the promoted-record path against a record that was never actually "+ + "promoted", id) + } + + beforeCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + if err := fixture.MutateExisting(ctx, id); err != nil { + t.Fatalf("mutating existing %s: %v", id, err) + } + afterCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + if afterCount != beforeCount+1 { + t.Errorf("version row count for %s went from %d to %d across an update-shaped mutation on an "+ + "already-promoted record, want exactly +1: the fence must skip only a legacy (NULL) record, "+ + "not every update (design §16.2b)", id, beforeCount, afterCount) + } +} + +// RunParticipationGenerationFlagOffSkipsUpdateOnParticipatingRecord pins the +// switch's off half for a record the fence would let through: created with +// the flag on (so participation_generation is stamped), then updated after +// the flag is turned back off, it must mint nothing. ProceedsForPromotedRecord +// shows the fence passes such a record, so only the flag stands between this +// update and a mint. No other case can see a writer that ignores the flag on +// updates: every other flag-off record is legacy, and the fence stops those +// first. +func RunParticipationGenerationFlagOffSkipsUpdateOnParticipatingRecord(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + if err := fixture.SetFlag(ctx, true); err != nil { + t.Fatalf("enabling versioned history: %v", err) + } + id := fixture.IssuePrefix + "-flag-off-skip" + if err := fixture.Mutate(ctx, id); err != nil { + t.Fatalf("mutating %s: %v", id, err) + } + if gen, err := fixture.ParticipationGeneration(ctx, id); err != nil { + t.Fatalf("reading participation_generation for %s: %v", id, err) + } else if gen == nil { + t.Fatalf("participation_generation for %s is NULL immediately after a create with the flag on — "+ + "this case cannot test the flag against a record the fence would have stopped anyway", id) + } + + if err := fixture.SetFlag(ctx, false); err != nil { + t.Fatalf("disabling versioned history: %v", err) + } + beforeRevision, err := fixture.CurrentRevision(ctx, id) + if err != nil { + t.Fatalf("reading current_revision for %s: %v", id, err) + } + beforeCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + + if err := fixture.MutateExisting(ctx, id); err != nil { + t.Fatalf("mutating existing %s: %v", id, err) + } + + afterRevision, err := fixture.CurrentRevision(ctx, id) + if err != nil { + t.Fatalf("reading current_revision for %s: %v", id, err) + } + afterCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + if afterCount != beforeCount { + t.Errorf("version row count for %s went from %d to %d across an update-shaped mutation with the "+ + "flag off, want unchanged: turning versioned history off stops minting for every record, "+ + "including one that already participates", id, beforeCount, afterCount) + } + if afterRevision != beforeRevision { + t.Errorf("current_revision for %s went from %d to %d across the same update with the flag off, "+ + "want unchanged", id, beforeRevision, afterRevision) + } +} + +// RunParticipationGenerationWispPromotionBeginsHistory pins that promoting a +// wisp onto the issues plane is CREATE-shaped in design §16.2b's sense. (This +// is wisp promotion, PromoteFromEphemeral: not R2.3's promotion of a legacy +// record, which is what ProceedsForPromotedRecord's name refers to.) The +// issues row a promotion inserts is brand new on that plane, and the wisp +// behind it was never versioned and never declared participation (FR-8), so +// there is no legacy state to preserve: with the flag on, the promotion stamps +// participation_generation and mints the record's first version, as a create +// there would. Treated as UPDATE-shaped, the fence finds the new row NULL and +// skips, and because nothing stamps the column afterwards every later update +// skips too, so a record created with the flag on is never versioned at all. +func RunParticipationGenerationWispPromotionBeginsHistory(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + runWispArrivalBeginsHistory(t, ctx, fixture, "promote", fixture.PromoteWisp) +} + +// RunParticipationGenerationWispPersistenceMoveBeginsHistory is +// RunParticipationGenerationWispPromotionBeginsHistory for the other way a +// wisp reaches the issues plane, a persistence-mode update (bd update +// --persistent). It needs its own case because it reaches a different mint +// site than promotion on every leg (see MovePersistent). +func RunParticipationGenerationWispPersistenceMoveBeginsHistory(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + runWispArrivalBeginsHistory(t, ctx, fixture, "move-persistent", fixture.MovePersistent) +} + +// runWispArrivalBeginsHistory is the body the two wisp-arrival cases share: +// with the flag on, a wisp that arrives on the issues plane through arrive +// carries a stamped participation_generation and exactly one version row, +// and the next update-shaped mutation mints normally. +func runWispArrivalBeginsHistory(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture, how string, arrive func(context.Context, string) error) { + t.Helper() + if err := fixture.SetFlag(ctx, true); err != nil { + t.Fatalf("enabling versioned history: %v", err) + } + id := fixture.IssuePrefix + "-" + how + if err := fixture.CreateWisp(ctx, id); err != nil { + t.Fatalf("creating wisp %s: %v", id, err) + } + if err := arrive(ctx, id); err != nil { + t.Fatalf("moving wisp %s onto the issues plane (%s): %v", id, how, err) + } + + gen, err := fixture.ParticipationGeneration(ctx, id) + if err != nil { + t.Fatalf("reading participation_generation for %s: %v", id, err) + } + if gen == nil { + t.Errorf("participation_generation for %s is NULL after the wisp reached the issues plane (%s) with "+ + "the flag on, want a stamped value: the issues row is new, so the arrival is create-shaped "+ + "(design §16.2b), and a NULL here leaves the record fenced as legacy for good", id, how) + } + arrivedCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + if arrivedCount != 1 { + t.Errorf("version row count for %s = %d after the wisp reached the issues plane (%s) with the flag "+ + "on, want 1: a wisp is never versioned (FR-8), so the arrival mints the record's first version", + id, arrivedCount, how) + } + + if err := fixture.MutateExisting(ctx, id); err != nil { + t.Fatalf("mutating existing %s: %v", id, err) + } + afterCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + if afterCount != arrivedCount+1 { + t.Errorf("version row count for %s went from %d to %d across an update-shaped mutation after the "+ + "wisp reached the issues plane (%s), want exactly +1: a record that arrived with the flag on is "+ + "not legacy, so the fence must let its updates mint", id, arrivedCount, afterCount, how) + } +} + +// RunParticipationGenerationWispFlagClearMintsNothing pins that the fence +// decides a row's plane by the TABLE that holds it, not by the row's flags. +// bd mol squash clears a wisp root's ephemeral flag in place, so the row +// stays in the wisps table carrying neither Ephemeral nor NoHistory, and a +// plane test read off those flags takes it for an issues-plane row. It is +// not one: a wisps-table row is never versioned (FR-8) and has no issues row +// whose participation_generation the fence could read. So the update must +// succeed and mint nothing. Read off the flags, the fence either aborts the +// whole update looking for an issues row that is not there, or, without the +// fence, mints a stray version for a wisp. +func RunParticipationGenerationWispFlagClearMintsNothing(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + runWispTableRowMintsNothing(t, ctx, fixture, "flag-clear", fixture.CreateWisp, fixture.ClearWispFlag) +} + +// RunParticipationGenerationWispRootSquashMintsNothing is +// RunParticipationGenerationWispFlagClearMintsNothing in the shape bd mol +// squash actually runs it: the root's close and its flag clear in one +// transaction, so a mint that fails on the cleared row takes the close down +// with it and the squash cannot complete. +func RunParticipationGenerationWispRootSquashMintsNothing(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + runWispTableRowMintsNothing(t, ctx, fixture, "squash", fixture.CreateWisp, fixture.SquashWispRoot) +} + +// RunParticipationGenerationUnflaggedWispCreateMintsNothing pins the +// create-shaped half of the same rule: a row CREATED in the wisps table +// without either flag (import's "wisp_plane" marker) reaches the +// create-shaped mint, and must come out of it with no error and no version, +// exactly as a flagged wisp does. +func RunParticipationGenerationUnflaggedWispCreateMintsNothing(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + runWispTableRowMintsNothing(t, ctx, fixture, "unflagged-create", fixture.CreateUnflaggedWisp) +} + +// runWispTableRowMintsNothing is the body the three wisps-table cases share: +// with the flag on, every step succeeds on id, the wisps table still holds id +// afterwards, and id ends with no issue_versions row. +func runWispTableRowMintsNothing(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture, how string, steps ...func(context.Context, string) error) { + t.Helper() + if err := fixture.SetFlag(ctx, true); err != nil { + t.Fatalf("enabling versioned history: %v", err) + } + id := fixture.IssuePrefix + "-" + how + for i, step := range steps { + if err := step(ctx, id); err != nil { + t.Fatalf("step %d of %s on wisps-table row %s with the flag on: %v — a row the wisps table "+ + "holds is never versioned (FR-8), so its mint must be a no-op, not an error that aborts "+ + "the mutation", i+1, how, id, err) + } + } + // The precondition, checked after the steps rather than assumed: a step + // that moved the row to the issues table would leave a NULL + // participation_generation there, the update-shaped mint would be fenced + // as legacy, and the zero count below would hold without saying anything + // about a wisps-table row. + if inWisps, err := fixture.InWispsTable(ctx, id); err != nil { + t.Fatalf("checking whether the wisps table holds %s: %v", id, err) + } else if !inWisps { + t.Fatalf("%s is not in the wisps table after %s — this case pins that a wisps-table row mints "+ + "nothing, and cannot say so about a row a step moved out of that table", id, how) + } + count, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + if count != 0 { + t.Errorf("version row count for wisps-table row %s = %d after %s with the flag on, want 0: a "+ + "wisp is never versioned (FR-8), whatever its flags say", id, count, how) + } +} + +// RunParticipationGenerationNoHistoryIssueCreateDeclaresParticipation pins +// that a create declares participation for every ISSUES-table row it makes +// with the flag on, a row carrying NoHistory included. Import keeps a +// promoted no-history wisp's durable row on the issues plane with its stray +// no_history=true (bd-r9uce). While the row says no-history it is not +// versioned, so the create mints nothing. But it was created with history +// on, so it is not legacy: once bd update --persistent repairs the flag in +// place (a same-plane normalize, update-shaped by design), the repair and +// every update after it must mint. Left NULL by the create, the column reads +// as legacy to the fence, and the row is never versioned at all. +func RunParticipationGenerationNoHistoryIssueCreateDeclaresParticipation(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + if err := fixture.SetFlag(ctx, true); err != nil { + t.Fatalf("enabling versioned history: %v", err) + } + id := fixture.IssuePrefix + "-no-history-create" + if err := fixture.CreateNoHistoryIssue(ctx, id); err != nil { + t.Fatalf("creating no-history issues-plane row %s: %v", id, err) + } + gen, err := fixture.ParticipationGeneration(ctx, id) + if err != nil { + t.Fatalf("reading participation_generation for %s: %v", id, err) + } + if gen == nil { + t.Errorf("participation_generation for %s is NULL after a create with the flag on, want a stamped "+ + "value: the row is new on the issues plane, so the create declares participation (design "+ + "§16.2b) even though its NoHistory flag keeps it unversioned for now", id) + } + if count, err := fixture.VersionRowCount(ctx, id); err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } else if count != 0 { + t.Errorf("version row count for %s = %d after a create carrying NoHistory, want 0: a no-history "+ + "row is not versioned while it says so", id, count) + } + + if err := fixture.MovePersistent(ctx, id); err != nil { + t.Fatalf("repairing %s to persistent: %v", id, err) + } + repairedCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + if repairedCount != 1 { + t.Errorf("version row count for %s = %d after the persistent repair, want 1: the row was created "+ + "with the flag on, so the fence must let the repair's update-shaped mint through", id, repairedCount) + } + + if err := fixture.MutateExisting(ctx, id); err != nil { + t.Fatalf("mutating existing %s: %v", id, err) + } + afterCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + if afterCount != repairedCount+1 { + t.Errorf("version row count for %s went from %d to %d across an update-shaped mutation after the "+ + "repair, want exactly +1", id, repairedCount, afterCount) + } +} + +// RunParticipationGenerationLegacyNoHistoryIssueStaysLegacy is +// RunParticipationGenerationNoHistoryIssueCreateDeclaresParticipation's +// negative twin, and pins R2.3: an ordinary write never promotes a legacy +// record. The same no-history issues-table row, created while the flag was +// OFF, is legacy. Only a create-shaped call stamps a flagged row, so once the +// flag is on, an update-shaped mutation must leave participation_generation +// NULL and mint nothing. So must the bd update --persistent repair that then +// clears the flag in place: that repair is update-shaped too (a same-plane +// normalize), so the row it leaves is an ordinary legacy row, still fenced. +func RunParticipationGenerationLegacyNoHistoryIssueStaysLegacy(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + if err := fixture.SetFlag(ctx, false); err != nil { + t.Fatalf("disabling versioned history: %v", err) + } + id := fixture.IssuePrefix + "-no-history-legacy" + if err := fixture.CreateNoHistoryIssue(ctx, id); err != nil { + t.Fatalf("creating no-history issues-plane row %s with the flag off: %v", id, err) + } + if gen, err := fixture.ParticipationGeneration(ctx, id); err != nil { + t.Fatalf("reading participation_generation for %s: %v", id, err) + } else if gen != nil { + t.Fatalf("participation_generation for %s = %d before the flag was ever turned on, want NULL — "+ + "this case cannot test that a legacy no-history row stays legacy against a row that was never "+ + "legacy", id, *gen) + } + + if err := fixture.SetFlag(ctx, true); err != nil { + t.Fatalf("enabling versioned history: %v", err) + } + beforeRevision, err := fixture.CurrentRevision(ctx, id) + if err != nil { + t.Fatalf("reading current_revision for %s: %v", id, err) + } + + assertStillLegacy := func(after string) { + t.Helper() + if gen, err := fixture.ParticipationGeneration(ctx, id); err != nil { + t.Fatalf("reading participation_generation for %s: %v", id, err) + } else if gen != nil { + t.Errorf("participation_generation for %s = %d after %s with the flag on, want NULL: the row "+ + "was created with the flag off, and an update-shaped write must not promote a legacy "+ + "record (R2.3), whatever its no-history flag says", id, *gen, after) + } + if count, err := fixture.VersionRowCount(ctx, id); err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } else if count != 0 { + t.Errorf("version row count for %s = %d after %s with the flag on, want 0: a legacy row's "+ + "update-shaped mint is fenced (design §16.2b)", id, count, after) + } + if revision, err := fixture.CurrentRevision(ctx, id); err != nil { + t.Fatalf("reading current_revision for %s: %v", id, err) + } else if revision != beforeRevision { + t.Errorf("current_revision for %s went from %d to %d after %s, want unchanged: a fenced "+ + "mint runs neither half of the seam's write", id, beforeRevision, revision, after) + } + } + + if err := fixture.MutateExisting(ctx, id); err != nil { + t.Fatalf("mutating existing %s: %v", id, err) + } + assertStillLegacy("an update-shaped mutation") + + if err := fixture.MovePersistent(ctx, id); err != nil { + t.Fatalf("repairing %s to persistent: %v", id, err) + } + assertStillLegacy("the persistent repair") +} + +// RunParticipationGenerationFenceIgnoresSchemaSkewHatch pins design §16.2(c): +// BD_IGNORE_SCHEMA_SKEW=1 downgrades CheckForwardDrift's refusal to a warning +// (internal/storage/schema/schema.go), but it must have no effect on this +// fence — the fence keys on the participation_generation column's real data, +// not on the migration cursor the hatch is about, so a write admitted through +// that hatch is still, correctly, skipped when the record is legacy. +func RunParticipationGenerationFenceIgnoresSchemaSkewHatch(t *testing.T, ctx context.Context, fixture ParticipationGenerationFixture) { + t.Helper() + t.Setenv("BD_IGNORE_SCHEMA_SKEW", "1") + + if err := fixture.SetFlag(ctx, false); err != nil { + t.Fatalf("disabling versioned history: %v", err) + } + id := fixture.IssuePrefix + "-schema-skew-hatch" + if err := fixture.Mutate(ctx, id); err != nil { + t.Fatalf("mutating %s: %v", id, err) + } + if err := fixture.SetFlag(ctx, true); err != nil { + t.Fatalf("enabling versioned history: %v", err) + } + beforeCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + + if err := fixture.MutateExisting(ctx, id); err != nil { + t.Fatalf("mutating existing %s: %v", id, err) + } + + afterCount, err := fixture.VersionRowCount(ctx, id) + if err != nil { + t.Fatalf("counting version rows for %s: %v", id, err) + } + if afterCount != beforeCount { + t.Errorf("version row count for %s went from %d to %d with BD_IGNORE_SCHEMA_SKEW=1 set, want "+ + "unchanged: the schema-skew hatch must not bypass the participation_generation fence — they "+ + "key on different planes (migration cursor vs. real column data) — so a write admitted "+ + "through the hatch against a legacy record must still be skipped", id, beforeCount, afterCount) + } +} diff --git a/backend/conformance/heartbeater_contract.go b/backend/conformance/heartbeater_contract.go new file mode 100644 index 000000000..bde6409f0 --- /dev/null +++ b/backend/conformance/heartbeater_contract.go @@ -0,0 +1,837 @@ +package conformance + +import ( + "context" + "errors" + "strings" + "testing" + "time" + + storeops "github.com/steveyegge/beads/internal/storage/issueops" + "github.com/steveyegge/beads/internal/types" + publicops "github.com/steveyegge/beads/issueops" +) + +// This file holds the contract every implementation of publicops.Heartbeater +// must satisfy. Each case asserts what issueops/heartbeater.go PROMISES, cited +// by symbol. +// +// THREE LEGS, ONE BODY. dolt, embedded dolt and the unit-of-work provider all +// reach internal/storage/issueops.ExecuteHeartbeatInTx, so a per-leg failure +// here is a wrapper's failure: a commit the leg added, a hook it fired, a +// refusal that stopped matching errors.Is. +// +// THE QUIET CASE IS THE POINT. A heartbeat is the hottest write in a fleet and +// it is cheap because it writes the lease row and nothing else. Most of what +// RunHeartbeaterChangesNothingOnTheRow asserts is an ABSENCE — no revision, no +// version, no updated_at, no event, no journal entry, no history entry, no +// hook — and each absence is something a plausible wrapper would add. +// +// THE LIVE-CLAIM FENCE IS AN INVARIANT AND A PREDICATE. The RefusesAfter* +// cases hold the invariant: each ends a claim one way and asserts both that +// the lease row is gone and that the holder's next heartbeat is refused. The +// RefusesAnOrphanedLease* cases hold the predicate: a lease row that survives +// on an issue that is no longer claimed by its holder (what a re-arm racing a +// release or close can leave on Dolt) is refused AND deleted, never refreshed. +type HeartbeaterFixture struct { + // IssuePrefix namespaces the ids each assertion seeds, so several of them + // can share one database. + IssuePrefix string + // Heartbeater is the surface under test. + Heartbeater publicops.Heartbeater + // CreateIssue seeds a durable issue in the issues plane. + CreateIssue func(context.Context, *types.Issue, string) error + // CreateWisp seeds an ephemeral issue in the wisps plane. A nil CreateWisp + // SKIPS the wisp case loudly. + CreateWisp func(context.Context, *types.Issue, string) error + // Claimer takes the claim, and with it the lease row, a heartbeat + // refreshes. + Claimer publicops.Claimer + // Lifecycle ends or moves a claim (close, a status move, a hand-doled + // claim) and performs the guarded write the revision case lands. + Lifecycle publicops.Lifecycle + // Releaser gives a claim up for the release case. Nil SKIPS that case. + Releaser publicops.Releaser + // LeaseReclaimer reverts an aged claim for the reclaim case. Nil, or a nil + // Exec, SKIPS that case. + LeaseReclaimer publicops.LeaseReclaimer + // Exec runs raw statements against the backing database: the cases use it + // to age a lease. + Exec func(ctx context.Context, statements []SQLStatement) error + // ExecUncommitted runs raw statements as ANOTHER writer that leaves its + // change uncommitted in the version-controlled working set (a batch-mode + // edit): SQL-committed, no version-control commit. Nil means Exec already + // behaves so. + ExecUncommitted func(ctx context.Context, statements []SQLStatement) error + // QueryScalar runs a single-row query and scans it, so the post-state is + // read RAW rather than through the role being tested. + QueryScalar func(context.Context, string, []any, ...any) error + // CountHistory reports how many version-control entries the fixture's + // branch has. Nil SKIPS that one assertion, loudly, in the quiet case. + CountHistory func(context.Context) (int, error) + // SetJournalEnabled turns on durable journaling, so the quiet case can + // observe that a heartbeat records nothing in bd_events_journal. Nil SKIPS + // that one assertion, loudly. + SetJournalEnabled func(enabled bool) + // SetVersionedHistoryEnabled turns on dual-write issue-version history, so + // the quiet case can observe that a heartbeat records no issue_versions + // row. Nil SKIPS that one assertion, loudly. + SetVersionedHistoryEnabled func(enabled bool) + // HookedHeartbeater is the same role taken off the leg's HOOK-FIRING chain + // (storage.HookFiringStore on the store legs, uow.NewNotifyingProvider on + // the unit-of-work leg), built over the runner FiredUpdates reads. Nil, + // with FiredUpdates, SKIPS the no-hook assertion loudly. + HookedHeartbeater publicops.Heartbeater + // FiredUpdates reports, in firing order, the issue id of every on_update + // the hooked chain ran so far. + FiredUpdates func(context.Context) ([]string, error) +} + +const ( + heartbeaterHolder = "hb-holder" + heartbeaterIntruder = "hb-intruder" + heartbeaterReaper = "hb-reaper" +) + +// RunHeartbeaterRefreshesTheHoldersLease pins the refresh itself +// (Heartbeater: "pushes the lease the caller holds forward by the store's +// TTL") and every member of the HeartbeatResult, against the row READ RAW. +func RunHeartbeaterRefreshesTheHoldersLease(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + requireHeartbeaterExec(t, fixture) + id := fixture.IssuePrefix + "-refresh" + heartbeaterSeedClaimed(t, ctx, fixture, id) + aged := time.Now().UTC().Add(-time.Minute).Truncate(time.Second) + if err := fixture.Exec(ctx, []SQLStatement{{ + Query: "UPDATE leases SET lease_expires_at = ?, heartbeat_at = ? WHERE issue_id = ?", + Args: []any{aged, aged, id}, + }}); err != nil { + t.Fatalf("age the lease on %s: %v", id, err) + } + + before := time.Now().UTC().Add(-time.Second) + result := heartbeat(t, ctx, fixture.Heartbeater, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}) + after := time.Now().UTC().Add(time.Second) + + if result.IssueID != id || result.Holder != heartbeaterHolder || result.Rearmed { + t.Fatalf("result = %+v, want {IssueID:%s Holder:%s Rearmed:false}", result, id, heartbeaterHolder) + } + if result.HeartbeatAt.Before(before) || result.HeartbeatAt.After(after) { + t.Fatalf("HeartbeatAt = %v, want the server clock at the call (between %v and %v)", result.HeartbeatAt, before, after) + } + if ttl := result.LeaseExpiresAt.Sub(result.HeartbeatAt); heartbeaterAbs(ttl-storeops.DefaultLeaseTTL) > time.Second { + t.Fatalf("LeaseExpiresAt - HeartbeatAt = %v, want the store's lease TTL %v", ttl, storeops.DefaultLeaseTTL) + } + if moved := heartbeaterScalar[int](t, ctx, fixture, + "SELECT COUNT(*) FROM leases WHERE issue_id = ? AND holder = ? AND lease_expires_at > ? AND heartbeat_at > ?", + id, heartbeaterHolder, aged, aged); moved != 1 { + t.Fatal("the lease row's lease_expires_at and heartbeat_at did not move forward") + } + heartbeaterRequireStoredMatches(t, ctx, fixture, id, result, before, after) +} + +// RunHeartbeaterASameSecondHeartbeatIsNotARearm pins HeartbeatResult.Rearmed +// against the refresh that changes no value: a heartbeat landing in the same +// second as the claim or the previous heartbeat writes values identical to the +// row's (the lease columns hold whole seconds), which some engines report as +// zero rows affected. It is still a refresh of the caller's own row: Rearmed +// is false, and the lease's granted_at and granted_node do not move. +func RunHeartbeaterASameSecondHeartbeatIsNotARearm(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + requireHeartbeaterExec(t, fixture) + for i := 0; i < 3; i++ { + id := fixture.IssuePrefix + "-samesec-" + string(rune('a'+i)) + heartbeaterSeedClaimed(t, ctx, fixture, id) + granted := heartbeaterScalar[string](t, ctx, fixture, + "SELECT CONCAT(CAST(granted_at AS CHAR), '|', COALESCE(granted_node, '')) FROM leases WHERE issue_id = ?", id) + for beat := 0; beat < 2; beat++ { + result := heartbeat(t, ctx, fixture.Heartbeater, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}) + if result.Rearmed { + t.Fatalf("heartbeat %d on %s right after the claim = %+v, want Rearmed:false: the holder's lease row existed", beat+1, id, result) + } + } + if got := heartbeaterScalar[string](t, ctx, fixture, + "SELECT CONCAT(CAST(granted_at AS CHAR), '|', COALESCE(granted_node, '')) FROM leases WHERE issue_id = ?", id); got != granted { + t.Fatalf("granted_at|granted_node on %s moved from %s to %s across refreshes; a refresh never re-grants", id, granted, got) + } + } +} + +// RunHeartbeaterChangesNothingOnTheRow pins the role's quiet promise +// (Heartbeater: "A REFRESH WRITES ONLY THE LEASE ROW"): the issue row's revision +// (row_lock), its current_revision, its updated_at, its events, the events +// journal, issue_versions, the version-control history and the hooks are all +// exactly where the claim left them. +func RunHeartbeaterChangesNothingOnTheRow(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + requireHeartbeaterExec(t, fixture) + if fixture.SetJournalEnabled != nil { + fixture.SetJournalEnabled(true) + defer fixture.SetJournalEnabled(false) + } else { + t.Log("HeartbeaterFixture.SetJournalEnabled is nil: the journal assertion is skipped on this backend") + } + if fixture.SetVersionedHistoryEnabled != nil { + fixture.SetVersionedHistoryEnabled(true) + defer fixture.SetVersionedHistoryEnabled(false) + } else { + t.Log("HeartbeaterFixture.SetVersionedHistoryEnabled is nil: the issue_versions assertion is skipped on this backend") + } + id := fixture.IssuePrefix + "-quiet" + heartbeaterSeedClaimed(t, ctx, fixture, id) + // updated_at is stored at second precision on some backends; step past + // the claim's second so a stamp the heartbeat added cannot hide in it. + time.Sleep(1100 * time.Millisecond) + + snapshot := func() heartbeaterRowSnapshot { + return heartbeaterSnapshot(t, ctx, fixture, id) + } + before := snapshot() + fired := heartbeaterFired(t, ctx, fixture, id) + + surface := fixture.Heartbeater + if fixture.HookedHeartbeater != nil && fixture.FiredUpdates != nil { + surface = fixture.HookedHeartbeater + } else { + t.Log("HeartbeaterFixture.HookedHeartbeater/FiredUpdates is nil: the no-hook assertion is skipped on this backend") + } + heartbeat(t, ctx, surface, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}) + + after := snapshot() + if before != after { + t.Fatalf("a heartbeat changed the issue's durable state:\nbefore %+v\nafter %+v", before, after) + } + if got := heartbeaterFired(t, ctx, fixture, id); got != fired { + t.Fatalf("on_update fired %d time(s) for %s across a refresh, want 0: a refresh fires no hook", got-fired, id) + } +} + +// RunHeartbeaterAGuardedWriteWithThePreHeartbeatRevisionStillWins is the +// reason the quiet case matters to a caller: the holder's revision token +// survives its own heartbeats, so a guarded write it composed from the claim +// still lands. +func RunHeartbeaterAGuardedWriteWithThePreHeartbeatRevisionStillWins(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + if fixture.Lifecycle == nil { + t.Skip("HeartbeaterFixture.Lifecycle is nil: this backend cannot land a guarded write") + } + id := fixture.IssuePrefix + "-guarded" + revision := heartbeaterSeedClaimed(t, ctx, fixture, id) + + heartbeat(t, ctx, fixture.Heartbeater, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}) + heartbeat(t, ctx, fixture.Heartbeater, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}) + + if _, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{ + Actor: heartbeaterHolder, IssueID: id, ExpectedVersion: &revision, + Patch: publicops.IssuePatch{Notes: publicops.Field[string]{Set: true, Value: "after two heartbeats"}}, + }); err != nil { + t.Fatalf("guarded write with the claim's revision after heartbeats = %v, want it to land", err) + } +} + +// RunHeartbeaterRefusesAForeignHolder pins the fence (Heartbeater REFUSALS: +// "an issue another actor holds: a *LeaseConflictError naming the Holder, +// wrapping ErrAlreadyClaimed"), and that the refusal writes nothing. +func RunHeartbeaterRefusesAForeignHolder(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + requireHeartbeaterExec(t, fixture) + id := fixture.IssuePrefix + "-foreign" + heartbeaterSeedClaimed(t, ctx, fixture, id) + // Age the holder's lease first, so a heartbeat that ignored the holder + // fence would really CHANGE the row (some engines count only changed rows, + // and the columns hold whole seconds: an unaged row refreshed in the + // claim's second changes nothing and would hide the missing fence). + aged := time.Now().UTC().Add(-time.Minute).Truncate(time.Second) + if err := fixture.Exec(ctx, []SQLStatement{{ + Query: "UPDATE leases SET lease_expires_at = ?, heartbeat_at = ? WHERE issue_id = ?", + Args: []any{aged, aged, id}, + }}); err != nil { + t.Fatalf("age the lease on %s: %v", id, err) + } + lease := heartbeaterScalar[string](t, ctx, fixture, "SELECT CONCAT(CAST(lease_expires_at AS CHAR), '|', CAST(heartbeat_at AS CHAR), '|', holder) FROM leases WHERE issue_id = ?", id) + + _, err := fixture.Heartbeater.Heartbeat(ctx, publicops.HeartbeatRequest{Actor: heartbeaterIntruder, IssueID: id}) + if !errors.Is(err, publicops.ErrAlreadyClaimed) { + t.Fatalf("heartbeat by a non-holder = %v, want ErrAlreadyClaimed", err) + } + if errors.Is(err, publicops.ErrLeaseNotHeld) { + t.Fatalf("heartbeat by a non-holder = %v also matches ErrLeaseNotHeld; the two refusals must stay distinct", err) + } + conflict := heartbeaterConflict(t, err) + if conflict.IssueID != id || conflict.Holder != heartbeaterHolder || conflict.Status != types.StatusInProgress { + t.Fatalf("LeaseConflictError = %+v, want {IssueID:%s Holder:%s Status:%s}", conflict, id, heartbeaterHolder, types.StatusInProgress) + } + if got := heartbeaterScalar[string](t, ctx, fixture, "SELECT CONCAT(CAST(lease_expires_at AS CHAR), '|', CAST(heartbeat_at AS CHAR), '|', holder) FROM leases WHERE issue_id = ?", id); got != lease { + t.Fatalf("a refused heartbeat moved the holder's lease from %s to %s", lease, got) + } +} + +// RunHeartbeaterCommitsOnlyItsOwnTables pins the commit discipline against a +// DIRTY working set (Heartbeater: "A REFRESH WRITES ONLY THE LEASE ROW"; "A +// RE-ARM IS RECORDED AS A MUTATION"): another writer has left an uncommitted +// versioned change (a batch-mode edit, here a config row). A refresh and a +// refusal make no version-control commit and leave that change uncommitted; +// a re-arm makes exactly one commit, of its own tables, and still leaves the +// other writer's change uncommitted rather than sweeping it in under the +// heartbeat's message. +func RunHeartbeaterCommitsOnlyItsOwnTables(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + requireHeartbeaterExec(t, fixture) + if fixture.CountHistory == nil || fixture.Lifecycle == nil { + t.Skip("HeartbeaterFixture.CountHistory/Lifecycle is nil: this backend has no version-control history to observe") + } + refreshed := fixture.IssuePrefix + "-dirty-refresh" + heartbeaterSeedClaimed(t, ctx, fixture, refreshed) + refused := fixture.IssuePrefix + "-dirty-refused" + heartbeaterSeed(t, ctx, fixture, refused) + rearmed := fixture.IssuePrefix + "-dirty-rearm" + heartbeaterSeed(t, ctx, fixture, rearmed) + if _, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{ + Actor: heartbeaterHolder, IssueID: rearmed, + Patch: publicops.IssuePatch{ + Status: publicops.Field[publicops.Status]{Set: true, Value: types.StatusInProgress}, + Assignee: publicops.Field[string]{Set: true, Value: heartbeaterHolder}, + }, + }); err != nil { + t.Fatalf("hand-dole %s: %v", rearmed, err) + } + + probe := "heartbeat.dirty-probe." + fixture.IssuePrefix + dirty := fixture.Exec + if fixture.ExecUncommitted != nil { + dirty = fixture.ExecUncommitted + } + if err := dirty(ctx, []SQLStatement{{ + Query: "REPLACE INTO config (`key`, value) VALUES (?, ?)", Args: []any{probe, "uncommitted"}, + }}); err != nil { + t.Fatalf("dirty the working set: %v", err) + } + defer func() { + _ = dirty(ctx, []SQLStatement{{Query: "DELETE FROM config WHERE `key` = ?", Args: []any{probe}}}) + }() + foreignDirty := func(when string) { + t.Helper() + if n := heartbeaterScalar[int](t, ctx, fixture, + "SELECT COUNT(*) FROM dolt_status WHERE table_name = 'config'"); n == 0 { + t.Fatalf("%s: the other writer's uncommitted config change was committed; a heartbeat commits only its own tables", when) + } + } + history := func() int { + t.Helper() + n, err := fixture.CountHistory(ctx) + if err != nil { + t.Fatalf("CountHistory: %v", err) + } + return n + } + foreignDirty("before any heartbeat") + before := history() + + heartbeat(t, ctx, fixture.Heartbeater, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: refreshed}) + if got := history(); got != before { + t.Fatalf("a refresh moved the version-control history %d -> %d; a refresh makes no commit", before, got) + } + foreignDirty("after a refresh") + + if _, err := fixture.Heartbeater.Heartbeat(ctx, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: refused}); err == nil { + t.Fatalf("heartbeat on unclaimed %s succeeded, want a refusal", refused) + } + if got := history(); got != before { + t.Fatalf("a refusal moved the version-control history %d -> %d; a refusal makes no commit", before, got) + } + foreignDirty("after a refusal") + + if result := heartbeat(t, ctx, fixture.Heartbeater, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: rearmed}); !result.Rearmed { + t.Fatalf("heartbeat on hand-doled %s = %+v, want Rearmed", rearmed, result) + } + if got := history(); got != before+1 { + t.Fatalf("a re-arm moved the version-control history %d -> %d, want exactly one commit", before, got) + } + foreignDirty("after a re-arm") +} + +// RunHeartbeaterRefusesAnOrphanedLeaseOnAReleasedIssue and +// ...OnAClosedIssue and ...OnAnIssueSomeoneElseHolds pin the live-claim +// predicate (Heartbeater: "THE LIVE-CLAIM FENCE IS A PREDICATE"): a lease row +// that names the caller but survives on an issue that is open, closed, or +// in_progress under another assignee is refused, never refreshed, and the +// refusal deletes it (Heartbeater: the one write a refusal makes). The row +// is planted raw: it is the state a re-arm racing a release or close leaves. +func RunHeartbeaterRefusesAnOrphanedLeaseOnAReleasedIssue(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + requireHeartbeaterExec(t, fixture) + id := fixture.IssuePrefix + "-orphan-open" + heartbeaterSeed(t, ctx, fixture, id) + heartbeaterRefusesAnOrphan(t, ctx, fixture, id, types.StatusOpen, "") +} + +func RunHeartbeaterRefusesAnOrphanedLeaseOnAClosedIssue(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + requireHeartbeaterExec(t, fixture) + if fixture.Lifecycle == nil { + t.Skip("HeartbeaterFixture.Lifecycle is nil: this backend cannot close the claim") + } + id := fixture.IssuePrefix + "-orphan-closed" + heartbeaterSeedClaimed(t, ctx, fixture, id) + if _, err := fixture.Lifecycle.Close(ctx, publicops.CloseRequest{Actor: heartbeaterHolder, IssueID: id, Reason: "done"}); err != nil { + t.Fatalf("close %s: %v", id, err) + } + heartbeaterRefusesAnOrphan(t, ctx, fixture, id, types.StatusClosed, "") +} + +func RunHeartbeaterRefusesAnOrphanedLeaseOnAnIssueSomeoneElseHolds(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + requireHeartbeaterExec(t, fixture) + if fixture.Lifecycle == nil { + t.Skip("HeartbeaterFixture.Lifecycle is nil: this backend cannot hand-dole a claim") + } + id := fixture.IssuePrefix + "-orphan-moved" + heartbeaterSeed(t, ctx, fixture, id) + if _, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{ + Actor: heartbeaterIntruder, IssueID: id, + Patch: publicops.IssuePatch{ + Status: publicops.Field[publicops.Status]{Set: true, Value: types.StatusInProgress}, + Assignee: publicops.Field[string]{Set: true, Value: heartbeaterIntruder}, + }, + }); err != nil { + t.Fatalf("hand-dole %s to %s: %v", id, heartbeaterIntruder, err) + } + heartbeaterRefusesAnOrphan(t, ctx, fixture, id, types.StatusInProgress, heartbeaterIntruder) +} + +// heartbeaterRefusesAnOrphan plants a lease row for heartbeaterHolder on id +// (which the holder does not hold), heartbeats as the holder, and asserts the +// refusal and that the row is gone. +func heartbeaterRefusesAnOrphan(t *testing.T, ctx context.Context, fixture HeartbeaterFixture, id string, status types.Status, foreign string) { + t.Helper() + now := time.Now().UTC().Truncate(time.Second) + if err := fixture.Exec(ctx, []SQLStatement{ + {Query: "DELETE FROM leases WHERE issue_id = ?", Args: []any{id}}, + { + Query: "INSERT INTO leases (issue_id, holder, granted_at, lease_expires_at, heartbeat_at, granted_node) VALUES (?, ?, ?, ?, ?, '')", + Args: []any{id, heartbeaterHolder, now.Add(-time.Minute), now.Add(time.Hour), now.Add(-time.Minute)}, + }, + }); err != nil { + t.Fatalf("plant an orphaned lease on %s: %v", id, err) + } + + _, err := fixture.Heartbeater.Heartbeat(ctx, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}) + conflict := heartbeaterConflict(t, err) + if foreign != "" { + if !errors.Is(err, publicops.ErrAlreadyClaimed) || conflict.Holder != foreign { + t.Fatalf("heartbeat over an orphaned lease on an issue %s holds = %v (%+v), want ErrAlreadyClaimed naming %s", foreign, err, conflict, foreign) + } + } else if !errors.Is(err, publicops.ErrLeaseNotHeld) || conflict.Holder != "" { + t.Fatalf("heartbeat over an orphaned lease on a %s issue = %v (%+v), want ErrLeaseNotHeld", status, err, conflict) + } + if conflict.IssueID != id || conflict.Status != status || conflict.Ephemeral { + t.Fatalf("LeaseConflictError = %+v, want {IssueID:%s Status:%s Ephemeral:false}", conflict, id, status) + } + if n := heartbeaterScalar[int](t, ctx, fixture, "SELECT COUNT(*) FROM leases WHERE issue_id = ?", id); n != 0 { + t.Fatalf("lease rows on %s after the refusal = %d, want 0: a refusal deletes the caller's orphaned lease", id, n) + } + // And it stays refused: the next heartbeat finds no row to refresh. + if _, err := fixture.Heartbeater.Heartbeat(ctx, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}); err == nil { + t.Fatalf("a second heartbeat on %s succeeded after the orphan was refused", id) + } +} + +// heartbeaterRequireStoredMatches pins the reported times to the stored row +// (LeaseRenewal: "exactly what the lease row now holds"): lease_expires_at and +// heartbeat_at as stored are the result's, within the columns' one-second +// precision, and the stored expiry is the call's clock plus the store's TTL. +func heartbeaterRequireStoredMatches(t *testing.T, ctx context.Context, fixture HeartbeaterFixture, id string, result publicops.HeartbeatResult, before, after time.Time) { + t.Helper() + window := func(at time.Time) (time.Time, time.Time) { return at.Add(-time.Second), at.Add(time.Second) } + hbLo, hbHi := window(result.HeartbeatAt) + exLo, exHi := window(result.LeaseExpiresAt) + if n := heartbeaterScalar[int](t, ctx, fixture, + "SELECT COUNT(*) FROM leases WHERE issue_id = ? AND holder = ? AND heartbeat_at BETWEEN ? AND ? AND lease_expires_at BETWEEN ? AND ?", + id, result.Holder, hbLo, hbHi, exLo, exHi); n != 1 { + t.Fatalf("the stored lease row on %s does not hold the reported heartbeat_at %v and lease_expires_at %v (within 1s)", + id, result.HeartbeatAt, result.LeaseExpiresAt) + } + ttlLo, ttlHi := before.Add(storeops.DefaultLeaseTTL), after.Add(storeops.DefaultLeaseTTL) + if n := heartbeaterScalar[int](t, ctx, fixture, + "SELECT COUNT(*) FROM leases WHERE issue_id = ? AND lease_expires_at BETWEEN ? AND ?", + id, ttlLo, ttlHi); n != 1 { + t.Fatalf("the stored lease_expires_at on %s is not the call's clock plus the lease TTL %v", id, storeops.DefaultLeaseTTL) + } + if !result.HeartbeatAt.Equal(result.HeartbeatAt.Truncate(time.Second)) || !result.LeaseExpiresAt.Equal(result.LeaseExpiresAt.Truncate(time.Second)) { + t.Fatalf("result times %v / %v carry sub-second digits the lease columns cannot hold", result.HeartbeatAt, result.LeaseExpiresAt) + } +} + +// RunHeartbeaterRefusesAfterClose, ...AfterRelease, ...AfterReclaim and +// ...AfterStatusMovedOffInProgress pin the in_progress fence through the +// lease-row invariant (Heartbeater: "a lease row exists only while its issue +// is in_progress with that holder as assignee"): each ends the claim one way, +// asserts the lease row went with it, and that the former holder's heartbeat +// is refused with ErrLeaseNotHeld, which also matches ErrNotClaimable. +func RunHeartbeaterRefusesAfterClose(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + if fixture.Lifecycle == nil { + t.Skip("HeartbeaterFixture.Lifecycle is nil: this backend cannot close the claim") + } + heartbeaterRefusesAfter(t, ctx, fixture, "closed", types.StatusClosed, func(id string) error { + _, err := fixture.Lifecycle.Close(ctx, publicops.CloseRequest{Actor: heartbeaterHolder, IssueID: id, Reason: "done"}) + return err + }) +} + +func RunHeartbeaterRefusesAfterRelease(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + if fixture.Releaser == nil { + t.Skip("HeartbeaterFixture.Releaser is nil: this backend cannot release the claim") + } + heartbeaterRefusesAfter(t, ctx, fixture, "released", types.StatusOpen, func(id string) error { + _, err := fixture.Releaser.Release(ctx, publicops.ReleaseRequest{Actor: heartbeaterHolder, IssueID: id}) + return err + }) +} + +func RunHeartbeaterRefusesAfterReclaim(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + if fixture.LeaseReclaimer == nil || fixture.Exec == nil { + t.Skip("HeartbeaterFixture.LeaseReclaimer/Exec is nil: this backend cannot reclaim the claim") + } + heartbeaterRefusesAfter(t, ctx, fixture, "reclaimed", types.StatusOpen, func(id string) error { + if err := fixture.Exec(ctx, []SQLStatement{{ + Query: "UPDATE leases SET lease_expires_at = ? WHERE issue_id = ?", + Args: []any{time.Now().UTC().Add(-time.Hour), id}, + }}); err != nil { + return err + } + result, err := fixture.LeaseReclaimer.Reclaim(ctx, publicops.ReclaimRequest{ + Actor: heartbeaterReaper, Filter: publicops.ReclaimFilter{IDs: []string{id}}, + }) + if err == nil && len(result.Reclaimed) != 1 { + t.Fatalf("Reclaimed = %+v, want exactly %s", result.Reclaimed, id) + } + return err + }) +} + +func RunHeartbeaterRefusesAfterStatusMovedOffInProgress(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + if fixture.Lifecycle == nil { + t.Skip("HeartbeaterFixture.Lifecycle is nil: this backend cannot move the status") + } + heartbeaterRefusesAfter(t, ctx, fixture, "blocked", types.StatusBlocked, func(id string) error { + _, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{ + Actor: heartbeaterHolder, IssueID: id, + Patch: publicops.IssuePatch{Status: publicops.Field[publicops.Status]{Set: true, Value: types.StatusBlocked}}, + }) + return err + }) +} + +// RunHeartbeaterRefusesAWisp pins the plane rule (Heartbeater REFUSALS: "a +// wisp ... ErrLeaseNotHeld"): wisps are never leased, so even a wisp the +// caller holds in_progress is refused, and no lease row appears for it. +func RunHeartbeaterRefusesAWisp(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + if fixture.CreateWisp == nil || fixture.QueryScalar == nil { + t.Skip("HeartbeaterFixture.CreateWisp/QueryScalar is nil: this backend cannot seed a wisp") + } + id := fixture.IssuePrefix + "-wisp" + if err := fixture.CreateWisp(ctx, &types.Issue{ + ID: id, Title: id, Status: types.StatusInProgress, Assignee: heartbeaterHolder, + Priority: 2, IssueType: types.TypeTask, Ephemeral: true, + }, "seed"); err != nil { + t.Fatalf("seed wisp %s: %v", id, err) + } + + _, err := fixture.Heartbeater.Heartbeat(ctx, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}) + if !errors.Is(err, publicops.ErrLeaseNotHeld) || !errors.Is(err, publicops.ErrNotClaimable) { + t.Fatalf("heartbeat on a wisp = %v, want ErrLeaseNotHeld matching ErrNotClaimable", err) + } + if !strings.Contains(err.Error(), "ephemeral") { + t.Fatalf("heartbeat on a wisp = %q, want the refusal to say the issue is ephemeral", err) + } + if conflict := heartbeaterConflict(t, err); conflict.IssueID != id || conflict.Holder != "" { + t.Fatalf("LeaseConflictError = %+v, want {IssueID:%s Holder:\"\"}", conflict, id) + } + if n := heartbeaterScalar[int](t, ctx, fixture, "SELECT COUNT(*) FROM leases WHERE issue_id = ?", id); n != 0 { + t.Fatalf("lease rows for wisp %s = %d, want 0: wisps are never leased", id, n) + } +} + +// RunHeartbeaterRearmsAHandDoledClaim pins the self-heal (HeartbeatResult. +// Rearmed): an issue put in_progress with the caller as assignee by a generic +// update holds no lease row, and the holder's heartbeat grants one rather than +// refusing. The re-arm is recorded as a mutation (Heartbeater: "A RE-ARM IS +// RECORDED AS A MUTATION"): it remints the revision, which is what makes it +// collide with a racing release or close, and records a lease_rearmed event; +// the refresh after it does neither. +func RunHeartbeaterRearmsAHandDoledClaim(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + if fixture.Lifecycle == nil || fixture.QueryScalar == nil { + t.Skip("HeartbeaterFixture.Lifecycle/QueryScalar is nil: this backend cannot hand-dole a claim") + } + id := fixture.IssuePrefix + "-doled" + heartbeaterSeed(t, ctx, fixture, id) + if _, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{ + Actor: heartbeaterHolder, IssueID: id, + Patch: publicops.IssuePatch{ + Status: publicops.Field[publicops.Status]{Set: true, Value: types.StatusInProgress}, + Assignee: publicops.Field[string]{Set: true, Value: heartbeaterHolder}, + }, + }); err != nil { + t.Fatalf("hand-dole %s: %v", id, err) + } + if n := heartbeaterScalar[int](t, ctx, fixture, "SELECT COUNT(*) FROM leases WHERE issue_id = ?", id); n != 0 { + t.Fatalf("lease rows after a generic update = %d, want 0: the case needs a claim with no lease", n) + } + revision := heartbeaterScalar[int64](t, ctx, fixture, "SELECT row_lock FROM issues WHERE id = ?", id) + + before := time.Now().UTC().Add(-time.Second) + result := heartbeat(t, ctx, fixture.Heartbeater, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}) + after := time.Now().UTC().Add(time.Second) + if !result.Rearmed || result.Holder != heartbeaterHolder { + t.Fatalf("result = %+v, want Rearmed:true Holder:%s", result, heartbeaterHolder) + } + heartbeaterRequireStoredMatches(t, ctx, fixture, id, result, before, after) + if n := heartbeaterScalar[int](t, ctx, fixture, + "SELECT COUNT(*) FROM leases WHERE issue_id = ? AND holder = ? AND lease_expires_at > ?", + id, heartbeaterHolder, time.Now().UTC()); n != 1 { + t.Fatal("the re-armed heartbeat left no live lease row for the holder") + } + rearmed := heartbeaterScalar[int64](t, ctx, fixture, "SELECT row_lock FROM issues WHERE id = ?", id) + if rearmed == revision { + t.Fatalf("row_lock stayed %d across a re-arming heartbeat; a re-arm remints it so a racing release or close collides with it", revision) + } + rearmEvents := func() int { + return heartbeaterScalar[int](t, ctx, fixture, + "SELECT COUNT(*) FROM events WHERE issue_id = ? AND event_type = ?", id, string(types.EventLeaseRearmed)) + } + if n := rearmEvents(); n != 1 { + t.Fatalf("lease_rearmed events on %s after a re-arm = %d, want 1: a re-arm is recorded as a mutation", id, n) + } + // The next heartbeat refreshes the lease it just granted: no re-arm, and + // no revision change. + if again := heartbeat(t, ctx, fixture.Heartbeater, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}); again.Rearmed { + t.Fatalf("second heartbeat after the re-arm = %+v, want Rearmed:false", again) + } + if got := heartbeaterScalar[int64](t, ctx, fixture, "SELECT row_lock FROM issues WHERE id = ?", id); got != rearmed { + t.Fatalf("row_lock moved from %d to %d across a refresh after the re-arm", rearmed, got) + } + if n := rearmEvents(); n != 1 { + t.Fatalf("lease_rearmed events on %s after a refresh = %d, want still 1: a refresh records nothing", id, n) + } +} + +// RunHeartbeaterAnswersNotFoundForAnAbsentID pins Heartbeater REFUSALS: "an +// IssueID that names no row on either plane: ErrNotFound". +func RunHeartbeaterAnswersNotFoundForAnAbsentID(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + _, err := fixture.Heartbeater.Heartbeat(ctx, publicops.HeartbeatRequest{ + Actor: heartbeaterHolder, IssueID: fixture.IssuePrefix + "-absent", + }) + if !errors.Is(err, publicops.ErrNotFound) { + t.Fatalf("heartbeat on an absent id = %v, want ErrNotFound", err) + } +} + +// RunHeartbeaterRefusesABlankOrOverLongActor pins the request rules +// (HeartbeatRequest.Actor, Heartbeater REFUSALS): each is a +// *HeartbeatFieldError naming its field, matching ErrValidation. +func RunHeartbeaterRefusesABlankOrOverLongActor(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + id := fixture.IssuePrefix + "-refusals" + for _, test := range []struct { + name string + request publicops.HeartbeatRequest + field string + }{ + {"an empty actor", publicops.HeartbeatRequest{IssueID: id}, publicops.HeartbeatFieldActor}, + {"a blank actor", publicops.HeartbeatRequest{Actor: " \t", IssueID: id}, publicops.HeartbeatFieldActor}, + {"an over-long actor", publicops.HeartbeatRequest{Actor: strings.Repeat("a", types.MaxFieldLen+1), IssueID: id}, publicops.HeartbeatFieldActor}, + {"an empty id", publicops.HeartbeatRequest{Actor: heartbeaterHolder}, publicops.HeartbeatFieldIssueID}, + } { + t.Run(test.name, func(t *testing.T) { + _, err := fixture.Heartbeater.Heartbeat(ctx, test.request) + if !errors.Is(err, publicops.ErrValidation) { + t.Fatalf("Heartbeat(%s) = %v, want ErrValidation", test.name, err) + } + var field *publicops.HeartbeatFieldError + if !errors.As(err, &field) || field.Field != test.field { + t.Fatalf("Heartbeat(%s) = %v, want a *HeartbeatFieldError naming %q", test.name, err, test.field) + } + }) + } +} + +// RunHeartbeaterDoesNotMutateTheRequest pins the role's "never mutate +// caller-owned request values". +func RunHeartbeaterDoesNotMutateTheRequest(t *testing.T, ctx context.Context, fixture HeartbeaterFixture) { + t.Helper() + id := fixture.IssuePrefix + "-nomutate" + heartbeaterSeedClaimed(t, ctx, fixture, id) + request := publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id} + want := request + heartbeat(t, ctx, fixture.Heartbeater, request) + if request != want { + t.Fatalf("request after Heartbeat = %+v, want %+v", request, want) + } +} + +// heartbeaterRefusesAfter seeds and claims one issue, ends the claim with end, +// and asserts the invariant and the refusal. +func heartbeaterRefusesAfter(t *testing.T, ctx context.Context, fixture HeartbeaterFixture, suffix string, status types.Status, end func(id string) error) { + t.Helper() + if fixture.QueryScalar == nil { + t.Skip("HeartbeaterFixture.QueryScalar is nil: this backend cannot read the lease row") + } + id := fixture.IssuePrefix + "-after-" + suffix + heartbeaterSeedClaimed(t, ctx, fixture, id) + if n := heartbeaterScalar[int](t, ctx, fixture, "SELECT COUNT(*) FROM leases WHERE issue_id = ?", id); n != 1 { + t.Fatalf("lease rows for claimed %s = %d, want 1", id, n) + } + if err := end(id); err != nil { + t.Fatalf("end the claim on %s (%s): %v", id, suffix, err) + } + if n := heartbeaterScalar[int](t, ctx, fixture, "SELECT COUNT(*) FROM leases WHERE issue_id = ?", id); n != 0 { + t.Fatalf("lease rows for %s %s = %d, want 0: the path that ended the claim left its lease row", suffix, id, n) + } + + _, err := fixture.Heartbeater.Heartbeat(ctx, publicops.HeartbeatRequest{Actor: heartbeaterHolder, IssueID: id}) + if !errors.Is(err, publicops.ErrLeaseNotHeld) || !errors.Is(err, publicops.ErrNotClaimable) { + t.Fatalf("heartbeat after the claim was %s = %v, want ErrLeaseNotHeld matching ErrNotClaimable", suffix, err) + } + if errors.Is(err, publicops.ErrAlreadyClaimed) { + t.Fatalf("heartbeat after the claim was %s = %v also matches ErrAlreadyClaimed", suffix, err) + } + conflict := heartbeaterConflict(t, err) + if conflict.IssueID != id || conflict.Holder != "" || conflict.Status != status { + t.Fatalf("LeaseConflictError = %+v, want {IssueID:%s Holder:\"\" Status:%s}", conflict, id, status) + } + if n := heartbeaterScalar[int](t, ctx, fixture, "SELECT COUNT(*) FROM leases WHERE issue_id = ?", id); n != 0 { + t.Fatalf("a refused heartbeat left %d lease row(s) for %s", n, id) + } +} + +// heartbeaterRowSnapshot is every durable trace a heartbeat must not leave. +// A field the backend cannot observe holds -1. +type heartbeaterRowSnapshot struct { + RowLock int64 + CurrentRevision int64 + UpdatedAt string + Events int + JournalMaxSeq int64 + IssueVersions int + History int +} + +func heartbeaterSnapshot(t *testing.T, ctx context.Context, fixture HeartbeaterFixture, id string) heartbeaterRowSnapshot { + t.Helper() + snap := heartbeaterRowSnapshot{ + RowLock: heartbeaterScalar[int64](t, ctx, fixture, "SELECT row_lock FROM issues WHERE id = ?", id), + CurrentRevision: heartbeaterScalar[int64](t, ctx, fixture, "SELECT current_revision FROM issues WHERE id = ?", id), + UpdatedAt: heartbeaterScalar[string](t, ctx, fixture, "SELECT CAST(updated_at AS CHAR) FROM issues WHERE id = ?", id), + Events: heartbeaterScalar[int](t, ctx, fixture, "SELECT COUNT(*) FROM events WHERE issue_id = ?", id), + JournalMaxSeq: -1, + IssueVersions: -1, + History: -1, + } + if fixture.SetJournalEnabled != nil { + snap.JournalMaxSeq = heartbeaterScalar[int64](t, ctx, fixture, "SELECT COALESCE(MAX(seq), 0) FROM bd_events_journal") + } + if fixture.SetVersionedHistoryEnabled != nil { + snap.IssueVersions = heartbeaterScalar[int](t, ctx, fixture, "SELECT COUNT(*) FROM issue_versions WHERE issue_id = ?", id) + } + if fixture.CountHistory != nil { + n, err := fixture.CountHistory(ctx) + if err != nil { + t.Fatalf("CountHistory: %v", err) + } + snap.History = n + } + return snap +} + +func heartbeaterFired(t *testing.T, ctx context.Context, fixture HeartbeaterFixture, id string) int { + t.Helper() + if fixture.HookedHeartbeater == nil || fixture.FiredUpdates == nil { + return 0 + } + ids, err := fixture.FiredUpdates(ctx) + if err != nil { + t.Fatalf("FiredUpdates: %v", err) + } + n := 0 + for _, fired := range ids { + if fired == id { + n++ + } + } + return n +} + +func requireHeartbeaterExec(t *testing.T, fixture HeartbeaterFixture) { + t.Helper() + if fixture.Exec == nil || fixture.QueryScalar == nil { + t.Skip("HeartbeaterFixture.Exec/QueryScalar is nil: this backend cannot read or age a lease row") + } +} + +func heartbeaterSeed(t *testing.T, ctx context.Context, fixture HeartbeaterFixture, id string) { + t.Helper() + if err := fixture.CreateIssue(ctx, &types.Issue{ + ID: id, Title: id, Status: types.StatusOpen, Priority: 2, IssueType: types.TypeTask, + }, "seed"); err != nil { + t.Fatalf("seed %s: %v", id, err) + } +} + +// heartbeaterSeedClaimed creates id and claims it as heartbeaterHolder through +// the leg's Claimer, answering the claim's row version. +func heartbeaterSeedClaimed(t *testing.T, ctx context.Context, fixture HeartbeaterFixture, id string) int64 { + t.Helper() + if fixture.Claimer == nil { + t.Skip("HeartbeaterFixture.Claimer is nil: this backend cannot take the claim a heartbeat refreshes") + } + heartbeaterSeed(t, ctx, fixture, id) + claimed, err := fixture.Claimer.Claim(ctx, publicops.ClaimRequest{Actor: heartbeaterHolder, IssueID: id}) + if err != nil { + t.Fatalf("claim %s as %s: %v", id, heartbeaterHolder, err) + } + if claimed.Issue == nil { + t.Fatalf("claim %s answered no issue", id) + } + return claimed.Issue.RowVersion +} + +func heartbeat(t *testing.T, ctx context.Context, surface publicops.Heartbeater, request publicops.HeartbeatRequest) publicops.HeartbeatResult { + t.Helper() + result, err := surface.Heartbeat(ctx, request) + if err != nil { + t.Fatalf("Heartbeat(%+v): %v", request, err) + } + return result +} + +func heartbeaterConflict(t *testing.T, err error) *publicops.LeaseConflictError { + t.Helper() + var conflict *publicops.LeaseConflictError + if !errors.As(err, &conflict) { + t.Fatalf("refusal %v (%T) is not a *LeaseConflictError", err, err) + } + return conflict +} + +func heartbeaterScalar[T any](t *testing.T, ctx context.Context, fixture HeartbeaterFixture, query string, args ...any) T { + t.Helper() + var value T + if err := fixture.QueryScalar(ctx, query, args, &value); err != nil { + t.Fatalf("%s %v: %v", query, args, err) + } + return value +} + +func heartbeaterAbs(d time.Duration) time.Duration { + if d < 0 { + return -d + } + return d +} diff --git a/backend/conformance/lifecycle_create_gate_contract.go b/backend/conformance/lifecycle_create_gate_contract.go new file mode 100644 index 000000000..4f5c22d30 --- /dev/null +++ b/backend/conformance/lifecycle_create_gate_contract.go @@ -0,0 +1,170 @@ +package conformance + +import ( + "context" + "errors" + "fmt" + "strings" + "testing" + "time" + + "github.com/steveyegge/beads/internal/types" + publicops "github.com/steveyegge/beads/issueops" +) + +// This file and its two siblings (lifecycle_update_gate_contract.go, +// batch_apply_gate_contract.go) hold the gate-member clauses of Lifecycle.Create, +// Lifecycle.Update and BatchApplier: await_type, await_id, timeout and waiters +// on a create, await_id and waiters on a patch, and the one set of bounds every +// route refuses with a *publicops.GateFieldError. +// +// THE BOUNDS ARE THE COLUMNS', and the boundary is asserted from both sides: a +// value AT the bound lands whole, a value one past it is refused naming its +// member and writes nothing. await_type is VARCHAR(32) and await_id +// VARCHAR(255), both counted in characters, so each at-bound value is +// multi-byte — a byte count would refuse it. waiters is a TEXT column holding +// a JSON array, bounded in BYTES. A negative timeout is the one refusal that is +// not a width. +// +// NOTHING ELSE IS A RULE, and two cases say so: a gate member lands on an +// issue of any type (local `bd update --await-id` has always worked on any +// row), and waiters are stored as given, duplicates included (deduplication is +// the CLI's). A backend that grew a stricter rule fails here. + +// gateFieldAtBoundAwaitType is a 32-character, 64-byte await_type. +var gateFieldAtBoundAwaitType = strings.Repeat("é", 32) + +// gateFieldAtBoundAwaitID is a 255-character, 510-byte await_id. +var gateFieldAtBoundAwaitID = strings.Repeat("é", types.MaxFieldLen) + +// gateFieldAtBoundWaiters is one waiter whose JSON array encoding is exactly +// types.MaxTextBytes bytes: the entry plus `["` and `"]`. +func gateFieldAtBoundWaiters() []string { + return []string{strings.Repeat("w", types.MaxTextBytes-4)} +} + +// gateFieldOverBoundWaiters encodes to one byte past the TEXT column. +func gateFieldOverBoundWaiters() []string { + return []string{strings.Repeat("w", types.MaxTextBytes-3)} +} + +// assertGateFieldError checks err is ErrValidation carried by a +// *publicops.GateFieldError naming field. +func assertGateFieldError(t *testing.T, err error, label, field string) { + t.Helper() + if !errors.Is(err, publicops.ErrValidation) { + t.Fatalf("%s: error = %v, want ErrValidation", label, err) + } + var fieldErr *publicops.GateFieldError + if !errors.As(err, &fieldErr) { + t.Fatalf("%s: error = %v, want a *GateFieldError naming %s", label, err, field) + } + if fieldErr.Field != field { + t.Errorf("%s: GateFieldError.Field = %q, want %q", label, fieldErr.Field, field) + } +} + +// gateMembers renders the four gate members off an issue for comparison. +func gateMembers(issue *types.Issue) string { + waiters := issue.Waiters + if len(waiters) == 0 { + waiters = nil + } + return fmt.Sprintf("await_type=%q await_id=%q timeout=%s waiters=%q", issue.AwaitType, issue.AwaitID, issue.Timeout, waiters) +} + +func assertGateMembers(t *testing.T, id, label string, issue *types.Issue, awaitType, awaitID string, timeout time.Duration, waiters []string) { + t.Helper() + if issue == nil { + t.Fatalf("%s %s: no issue to read the gate members off", id, label) + } + if len(waiters) == 0 { + waiters = nil + } + want := fmt.Sprintf("await_type=%q await_id=%q timeout=%s waiters=%q", awaitType, awaitID, timeout, waiters) + if got := gateMembers(issue); got != want { + // The at-bound values are long; report sizes rather than the values. + if len(got)+len(want) > 2000 { + t.Errorf("%s %s gate members differ (got %d bytes, want %d bytes; await_type %d/%d runes, await_id %d/%d runes, waiters %d/%d entries)", + id, label, len(got), len(want), + len([]rune(issue.AwaitType)), len([]rune(awaitType)), len([]rune(issue.AwaitID)), len([]rune(awaitID)), + len(issue.Waiters), len(waiters)) + return + } + t.Errorf("%s %s gate members = %s, want %s", id, label, got, want) + } +} + +// RunLifecycleCreateWritesTheGateMembers pins that Lifecycle.Create stores all +// four gate members (CreateRequest.Issue's "gate" fields) on the row and +// answers them on the result, with the waiter list stored as given, duplicate +// included, and on an issue that is not of the gate type. +func RunLifecycleCreateWritesTheGateMembers(t *testing.T, ctx context.Context, fixture LifecycleCreateFixture) { + t.Helper() + + gate := fixture.IssuePrefix + "-lcg-gate" + issue := lifecycleCreateIssue(gate) + issue.IssueType = types.TypeGate + issue.AwaitType = "gh:run" + issue.AwaitID = "12345" + issue.Timeout = 90 * time.Minute + issue.Waiters = []string{"rig/workers/a", "rig/workers/b", "rig/workers/a"} + created, err := fixture.Lifecycle.Create(ctx, publicops.CreateRequest{Actor: "writer", ForceIDPrefix: true, Issue: issue}) + if err != nil { + t.Fatalf("create gate %s: %v", gate, err) + } + want := []string{"rig/workers/a", "rig/workers/b", "rig/workers/a"} + assertGateMembers(t, gate, "in the create result", created.Issue, "gh:run", "12345", 90*time.Minute, want) + assertGateMembers(t, gate, "in the stored row", lifecycleCreateRow(t, ctx, fixture, gate), "gh:run", "12345", 90*time.Minute, want) + + // Any type carries them: no gate-type-only rule. + task := fixture.IssuePrefix + "-lcg-task" + carrier := lifecycleCreateIssue(task) + carrier.AwaitType = "formula-defined" + carrier.AwaitID = "bead:" + gate + carrier.Waiters = []string{"mail:someone"} + if _, err := fixture.Lifecycle.Create(ctx, publicops.CreateRequest{Actor: "writer", ForceIDPrefix: true, Issue: carrier}); err != nil { + t.Fatalf("create task %s carrying gate members: %v", task, err) + } + assertGateMembers(t, task, "in the stored row", lifecycleCreateRow(t, ctx, fixture, task), "formula-defined", "bead:"+gate, 0, []string{"mail:someone"}) +} + +// RunLifecycleCreateBoundsTheGateMembers pins the four GateFieldError bounds +// on create from both sides: each at-bound value lands whole, each value one +// past it is refused as ErrValidation naming its member, and the refused +// create leaves no row. +func RunLifecycleCreateBoundsTheGateMembers(t *testing.T, ctx context.Context, fixture LifecycleCreateFixture) { + t.Helper() + + atBound := fixture.IssuePrefix + "-lcg-atbound" + issue := lifecycleCreateIssue(atBound) + issue.IssueType = types.TypeGate + issue.AwaitType = gateFieldAtBoundAwaitType + issue.AwaitID = gateFieldAtBoundAwaitID + issue.Timeout = 0 + issue.Waiters = gateFieldAtBoundWaiters() + if _, err := fixture.Lifecycle.Create(ctx, publicops.CreateRequest{Actor: "writer", ForceIDPrefix: true, Issue: issue}); err != nil { + t.Fatalf("create %s with every gate member at its bound: %v", atBound, err) + } + assertGateMembers(t, atBound, "in the stored row", lifecycleCreateRow(t, ctx, fixture, atBound), + gateFieldAtBoundAwaitType, gateFieldAtBoundAwaitID, 0, gateFieldAtBoundWaiters()) + + for _, test := range []struct { + name string + field string + mutate func(*types.Issue) + }{ + {"await_type", publicops.GateFieldAwaitType, func(i *types.Issue) { i.AwaitType = gateFieldAtBoundAwaitType + "x" }}, + {"await_id", publicops.GateFieldAwaitID, func(i *types.Issue) { i.AwaitID = gateFieldAtBoundAwaitID + "x" }}, + {"timeout", publicops.GateFieldTimeout, func(i *types.Issue) { i.Timeout = -time.Nanosecond }}, + {"waiters", publicops.GateFieldWaiters, func(i *types.Issue) { i.Waiters = gateFieldOverBoundWaiters() }}, + } { + id := fixture.IssuePrefix + "-lcg-over-" + strings.ReplaceAll(test.name, "_", "") + refused := lifecycleCreateIssue(id) + refused.IssueType = types.TypeGate + test.mutate(refused) + _, err := fixture.Lifecycle.Create(ctx, publicops.CreateRequest{Actor: "writer", ForceIDPrefix: true, Issue: refused}) + assertGateFieldError(t, err, "create with "+test.name+" past its bound", test.field) + assertLifecycleCreateAbsent(t, ctx, fixture, id, "after the refused "+test.name) + } +} diff --git a/backend/conformance/lifecycle_update_gate_contract.go b/backend/conformance/lifecycle_update_gate_contract.go new file mode 100644 index 000000000..06c730625 --- /dev/null +++ b/backend/conformance/lifecycle_update_gate_contract.go @@ -0,0 +1,133 @@ +package conformance + +import ( + "context" + "testing" + "time" + + publicops "github.com/steveyegge/beads/issueops" +) + +// The patch half of the gate-member clauses; see lifecycle_create_gate_contract.go. + +// RunLifecycleUpdatePatchesTheGateMembers pins IssuePatch.AwaitID and +// IssuePatch.Waiters: a set value lands and is answered on the result, waiters +// is a WHOLE-VALUE replacement stored as given (duplicates kept), a same-value +// patch is a no-op, a clear (empty await_id, nil waiters) empties both, and a +// second clear is a no-op. await_type and timeout are not patch members, so +// they ride through every edit untouched. The row is a task: no gate-type-only +// rule. +func RunLifecycleUpdatePatchesTheGateMembers(t *testing.T, ctx context.Context, fixture LifecycleUpdateFixture) { + t.Helper() + + id := fixture.IssuePrefix + "-lug-gate" + seeded := lifecycleUpdateIssue(id) + seeded.AwaitType = "timer" + seeded.AwaitID = "seeded-await" + seeded.Timeout = time.Minute + seeded.Waiters = []string{"seeded"} + seedLifecycleUpdateIssue(t, ctx, fixture, seeded) + + patch := publicops.IssuePatch{ + AwaitID: publicops.Field[string]{Set: true, Value: "run-42"}, + Waiters: publicops.Field[[]string]{Set: true, Value: []string{"w1", "w2", "w1"}}, + } + wantWaiters := []string{"w1", "w2", "w1"} + updated, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{Actor: "writer", IssueID: id, Patch: patch}) + if err != nil { + t.Fatalf("patch the gate members of %s: %v", id, err) + } + if !updated.Changed { + t.Errorf("patching the gate members of %s reported Changed = false, want a committed edit", id) + } + assertGateMembers(t, id, "in the update result", updated.Issue, "timer", "run-42", time.Minute, wantWaiters) + assertGateMembers(t, id, "in the stored row", lifecycleUpdateRow(t, ctx, fixture, id), "timer", "run-42", time.Minute, wantWaiters) + + after := lifecycleUpdateRow(t, ctx, fixture, id) + again, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{Actor: "writer", IssueID: id, Patch: patch}) + if err != nil { + t.Fatalf("re-apply the same gate patch to %s: %v", id, err) + } + if again.Changed { + t.Errorf("re-applying the same gate patch to %s reported Changed = true, want false", id) + } + assertLifecycleUpdateRowUnchanged(t, ctx, fixture, id, "after the same-value gate patch", after) + + clear := publicops.UpdateRequest{Actor: "writer", IssueID: id, Patch: publicops.IssuePatch{ + AwaitID: publicops.Field[string]{Set: true}, + Waiters: publicops.Field[[]string]{Set: true}, + }} + cleared, err := fixture.Lifecycle.Update(ctx, clear) + if err != nil { + t.Fatalf("clear the gate members of %s: %v", id, err) + } + if !cleared.Changed { + t.Errorf("clearing the gate members of %s reported Changed = false, want a committed edit", id) + } + assertGateMembers(t, id, "in the clear's result", cleared.Issue, "timer", "", time.Minute, nil) + assertGateMembers(t, id, "in the cleared row", lifecycleUpdateRow(t, ctx, fixture, id), "timer", "", time.Minute, nil) + + afterClear := lifecycleUpdateRow(t, ctx, fixture, id) + reclear, err := fixture.Lifecycle.Update(ctx, clear) + if err != nil { + t.Fatalf("re-clear the gate members of %s: %v", id, err) + } + if reclear.Changed { + t.Errorf("re-clearing the already-empty gate members of %s reported Changed = true, want false", id) + } + assertLifecycleUpdateRowUnchanged(t, ctx, fixture, id, "after the re-clear", afterClear) + + // An explicitly empty list clears exactly as a nil one does. + if _, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{Actor: "writer", IssueID: id, Patch: publicops.IssuePatch{ + Waiters: publicops.Field[[]string]{Set: true, Value: []string{"back"}}, + }}); err != nil { + t.Fatalf("re-set the waiters of %s: %v", id, err) + } + if _, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{Actor: "writer", IssueID: id, Patch: publicops.IssuePatch{ + Waiters: publicops.Field[[]string]{Set: true, Value: []string{}}, + }}); err != nil { + t.Fatalf("clear the waiters of %s with an empty list: %v", id, err) + } + assertGateMembers(t, id, "after the empty-list clear", lifecycleUpdateRow(t, ctx, fixture, id), "timer", "", time.Minute, nil) +} + +// RunLifecycleUpdateBoundsTheGateMembers pins the patch half of the +// GateFieldError bounds from both sides: at-bound await_id and waiters land +// whole, one past either is refused as ErrValidation naming its member, and +// the refusal writes nothing — not the gate member, and not an ordinary member +// riding in the same patch. +func RunLifecycleUpdateBoundsTheGateMembers(t *testing.T, ctx context.Context, fixture LifecycleUpdateFixture) { + t.Helper() + + id := fixture.IssuePrefix + "-lug-bounds" + seedLifecycleUpdateIssue(t, ctx, fixture, lifecycleUpdateIssue(id)) + + if _, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{Actor: "writer", IssueID: id, Patch: publicops.IssuePatch{ + AwaitID: publicops.Field[string]{Set: true, Value: gateFieldAtBoundAwaitID}, + Waiters: publicops.Field[[]string]{Set: true, Value: gateFieldAtBoundWaiters()}, + }}); err != nil { + t.Fatalf("patch %s with await_id and waiters at their bounds: %v", id, err) + } + assertGateMembers(t, id, "in the stored row", lifecycleUpdateRow(t, ctx, fixture, id), "", gateFieldAtBoundAwaitID, 0, gateFieldAtBoundWaiters()) + + before := lifecycleUpdateRow(t, ctx, fixture, id) + for _, test := range []struct { + name string + field string + patch publicops.IssuePatch + }{ + {"await_id", publicops.GateFieldAwaitID, publicops.IssuePatch{ + Title: publicops.Field[string]{Set: true, Value: "must not land"}, + AwaitID: publicops.Field[string]{Set: true, Value: gateFieldAtBoundAwaitID + "x"}, + }}, + {"waiters", publicops.GateFieldWaiters, publicops.IssuePatch{ + Title: publicops.Field[string]{Set: true, Value: "must not land"}, + Waiters: publicops.Field[[]string]{Set: true, Value: gateFieldOverBoundWaiters()}, + }}, + } { + _, err := fixture.Lifecycle.Update(ctx, publicops.UpdateRequest{Actor: "writer", IssueID: id, Patch: test.patch}) + assertGateFieldError(t, err, "patch with "+test.name+" past its bound", test.field) + assertLifecycleUpdateRowUnchanged(t, ctx, fixture, id, "after the refused "+test.name, before) + assertGateMembers(t, id, "after the refused "+test.name, lifecycleUpdateRow(t, ctx, fixture, id), "", gateFieldAtBoundAwaitID, 0, gateFieldAtBoundWaiters()) + } +} diff --git a/backend/conformance/portable.go b/backend/conformance/portable.go index 050b7f008..488c02593 100644 --- a/backend/conformance/portable.go +++ b/backend/conformance/portable.go @@ -42,6 +42,7 @@ func RunPortableMethods(t *testing.T, factory Factory) { t.Run("ImportIssueComment", func(t *testing.T) { testImportIssueComment(t, factory) }) t.Run("AddIssueCommentBurstOrder", func(t *testing.T) { testAddIssueCommentBurstOrder(t, factory) }) t.Run("PromoteFromEphemeral", func(t *testing.T) { testPromoteFromEphemeral(t, factory) }) + t.Run("PromoteClosedWispPreservesSession", func(t *testing.T) { testPromoteClosedWispPreservesSession(t, factory) }) t.Run("UpdateIssueID", func(t *testing.T) { testUpdateIssueID(t, factory) }) t.Run("DeleteIssuesBySourceRepo", func(t *testing.T) { testDeleteIssuesBySourceRepo(t, factory) }) t.Run("CreateIssuesWithFullOptions", func(t *testing.T) { testCreateIssuesWithFullOptions(t, factory) }) @@ -577,6 +578,36 @@ func testPromoteFromEphemeral(t *testing.T, f Factory) { } } +// testPromoteClosedWispPreservesSession verifies that promoting a *closed* +// ephemeral wisp preserves its closed_by_session provenance. Before the fix +// (GH#4662), closed_by_session was absent from the shared issue select/scan +// and insert column set, so promotion (read wisp -> insert issue) hydrated a +// zero value and dropped the original closing session. Promotion re-inserts +// through that shared (classic) writer, so this case guards GH#4662's path +// only; the domain writer's copy of the column (db.insertIssueRow) is pinned +// by the domain/db Insert tests. +func testPromoteClosedWispPreservesSession(t *testing.T, f Factory) { + s := f(t) + c := ctx() + + must(t, s.CreateIssue(c, withDefaults(&types.Issue{ID: "test-cw", Title: "Closed wisp", Ephemeral: true}), "a")) + must(t, s.CloseIssue(c, "test-cw", "done", "a", "sess-xyz")) + + must(t, s.PromoteFromEphemeral(c, "test-cw", "a")) + + got, err := s.GetIssue(c, "test-cw") + must(t, err) + if got.Ephemeral { + t.Error("promoted issue still Ephemeral") + } + if got.Status != types.StatusClosed { + t.Errorf("promoted issue status = %q, want %q", got.Status, types.StatusClosed) + } + if got.ClosedBySession != "sess-xyz" { + t.Errorf("closed_by_session after promote = %q, want %q (GH#4662)", got.ClosedBySession, "sess-xyz") + } +} + // --- Id rekey / source-repo purge / batch create --- func testUpdateIssueID(t *testing.T, f Factory) { diff --git a/backend/conformance/reader_contract.go b/backend/conformance/reader_contract.go index 2f93f818c..245a9efaa 100644 --- a/backend/conformance/reader_contract.go +++ b/backend/conformance/reader_contract.go @@ -3175,6 +3175,335 @@ func assertReaderBriefRow(t *testing.T, what string, brief, full *types.Issue) { } } +// RunReaderListTimeBoundsAreStrictAndWholeSecond pins the eight time bounds +// ListRequest carries beside the created pair — UpdatedAfter/Before, +// ClosedAfter/Before, DeferAfter/Before and DueAfter/Before — at their exact +// boundaries (reader.go: each is a strict bound on its column). +// +// THE BOUNDARY IS THE ASSERTION. Three rows sit one second apart around an +// instant T, so a body that compared inclusively, swapped the two ends, or +// bound the wrong column fails on a row rather than on nothing: +// +// - after=T selects exactly the T+1s row and before=T exactly the T-1s row, +// so the row AT T is excluded by both; +// - a bound carrying a sub-second remainder (T+900ms) behaves as T on both +// ends, because the bound is compared at whole-second precision (the +// storage builder formats it as RFC 3339 without a fraction); +// - a row whose column is NULL — an open row's closed_at, an unset +// defer_until or due_at — never matches either bound; +// - a bound spelled in a non-UTC zone selects exactly what the same instant +// spelled in UTC does. An offset is part of the instant, not decoration, +// and a body that dropped it would move the bound by the offset. +// +// Every family scopes itself by id and seeds no labels, so no write after the +// insert can move updated_at off the instant it was seeded at; AllFlag keeps +// the closed rows in view. +func RunReaderListTimeBoundsAreStrictAndWholeSecond(t *testing.T, ctx context.Context, fixture ReaderFixture) { + t.Helper() + at := time.Now().UTC().Truncate(time.Second).Add(-3 * time.Hour) + created := at.Add(-time.Hour) + instants := []struct { + tag string + at time.Time + }{ + {"early", at.Add(-time.Second)}, + {"exact", at}, + {"late", at.Add(time.Second)}, + } + + for _, family := range []struct { + name string + // set stamps the family's column onto a seed. + set func(issue *types.Issue, v time.Time) + // nullable seeds a fourth row with the column NULL. + nullable bool + after func(*publicops.ListRequest, *time.Time) + before func(*publicops.ListRequest, *time.Time) + }{ + { + name: "updated", + set: func(issue *types.Issue, v time.Time) { issue.UpdatedAt = v }, + after: func(r *publicops.ListRequest, v *time.Time) { r.UpdatedAfter = v }, + before: func(r *publicops.ListRequest, v *time.Time) { r.UpdatedBefore = v }, + }, + { + name: "closed", + set: func(issue *types.Issue, v time.Time) { + issue.Status = types.StatusClosed + issue.UpdatedAt = v + issue.ClosedAt = &v + }, + nullable: true, + after: func(r *publicops.ListRequest, v *time.Time) { r.ClosedAfter = v }, + before: func(r *publicops.ListRequest, v *time.Time) { r.ClosedBefore = v }, + }, + { + name: "defer", + set: func(issue *types.Issue, v time.Time) { issue.DeferUntil = &v }, + nullable: true, + after: func(r *publicops.ListRequest, v *time.Time) { r.DeferAfter = v }, + before: func(r *publicops.ListRequest, v *time.Time) { r.DeferBefore = v }, + }, + { + name: "due", + set: func(issue *types.Issue, v time.Time) { issue.DueAt = &v }, + nullable: true, + after: func(r *publicops.ListRequest, v *time.Time) { r.DueAfter = v }, + before: func(r *publicops.ListRequest, v *time.Time) { r.DueBefore = v }, + }, + } { + caseTag := "ltb" + family.name + ids := map[string]string{} + var scope []string + for _, inst := range instants { + id := readerID(fixture, caseTag, inst.tag) + ids[inst.tag] = id + scope = append(scope, id) + issue := readerIssue(id, types.TypeTask, "") + issue.CreatedAt, issue.UpdatedAt = created, created + family.set(issue, inst.at) + seedReaderIssue(t, ctx, fixture, issue) + } + if family.nullable { + id := readerID(fixture, caseTag, "null") + scope = append(scope, id) + issue := readerIssue(id, types.TypeTask, "") + issue.CreatedAt, issue.UpdatedAt = created, created + seedReaderIssue(t, ctx, fixture, issue) + } + idScope := readerIDFilter(scope...) + + list := func(what string, apply func(*publicops.ListRequest, *time.Time), bound time.Time) []string { + t.Helper() + req := publicops.ListRequest{IDFilter: idScope, AllFlag: true} + apply(&req, &bound) + page, err := fixture.Reader.List(ctx, req) + if err != nil { + t.Fatalf("List (%s %s): %v", family.name, what, err) + } + assertReaderPageNotNil(t, "List ("+family.name+" "+what+")", page) + got := readerPageIDs(page) + slices.Sort(got) + return got + } + expect := func(what string, apply func(*publicops.ListRequest, *time.Time), bound time.Time, want string) { + t.Helper() + if got := list(what, apply, bound); !slices.Equal(got, []string{want}) { + t.Errorf("List (%s %s %s) = %v, want exactly [%s]", family.name, what, bound.Format(time.RFC3339Nano), got, want) + } + } + + plus2 := time.FixedZone("UTC+2", 2*60*60) + for _, bound := range []struct { + what string + v time.Time + }{ + {"at T", at}, + {"at T with a sub-second remainder", at.Add(900 * time.Millisecond)}, + {"at T spelled in a +02:00 zone", at.In(plus2)}, + } { + expect("after "+bound.what, family.after, bound.v, ids["late"]) + expect("before "+bound.what, family.before, bound.v, ids["early"]) + } + + // The NULL row is outside even the widest bounds on both ends. + if family.nullable { + wide := at.Add(-24 * time.Hour) + if got, want := list("after a day earlier", family.after, wide), sortedCopy(ids["early"], ids["exact"], ids["late"]); !slices.Equal(got, want) { + t.Errorf("List (%s after a day earlier) = %v, want %v — a NULL column never matches", family.name, got, want) + } + if got, want := list("before a day later", family.before, at.Add(24*time.Hour)), sortedCopy(ids["early"], ids["exact"], ids["late"]); !slices.Equal(got, want) { + t.Errorf("List (%s before a day later) = %v, want %v — a NULL column never matches", family.name, got, want) + } + } + } +} + +// RunReaderListFilterFamiliesNarrowToTheirRows pins one included and one +// excluded row for each remaining ListRequest filter family that `bd list` +// publishes beyond the scope filters: the priority trio, the three text +// substrings, the empty-description and no-labels predicates, the top-level +// predicate, the type exclusion, the spec prefix, the label pattern and +// regex, the external-ref pair, the pinned-flag pair, the deferred and +// overdue predicates, the status exclusion and the molecule type. +// +// Each row is scoped by id and every arm asks AllFlag (the pinned arms +// excepted, which are about that interplay), so an arm whose filter the body +// dropped answers its whole scope and fails, and one whose filter the body +// inverted answers the other row. +// +// PinnedFlag with NoPinnedFlag is a contradiction, and the role refuses it as +// a validation error rather than letting one of the two silently win. +// ParentID with NoParent is refused the same way, as CountRequest refuses it. +func RunReaderListFilterFamiliesNarrowToTheirRows(t *testing.T, ctx context.Context, fixture ReaderFixture) { + t.Helper() + id := func(name string) string { return readerID(fixture, "lff", name) } + seed := func(name string, mutate func(*types.Issue)) string { + t.Helper() + issue := readerIssue(id(name), types.TypeTask, "") + if mutate != nil { + mutate(issue) + } + seedReaderIssue(t, ctx, fixture, issue) + return issue.ID + } + intp := func(v int) *int { return &v } + past := time.Now().UTC().Truncate(time.Second).Add(-48 * time.Hour) + future := time.Now().UTC().Truncate(time.Second).Add(48 * time.Hour) + label := readerLabel(fixture, "lffpat") + external := fixture.IssuePrefix + "-LFF-ext-17" + spec := "docs/" + fixture.IssuePrefix + "-lff/" + + p0 := seed("p0", func(i *types.Issue) { i.Priority = 0 }) + p2 := seed("p2", func(i *types.Issue) { i.Priority = 2 }) + p4 := seed("p4", func(i *types.Issue) { i.Priority = 4 }) + + textT := seed("text-t", func(i *types.Issue) { i.Title = "a title carrying ttok-lff" }) + textD := seed("text-d", func(i *types.Issue) { i.Description = "a description carrying dtok-lff" }) + textN := seed("text-n", func(i *types.Issue) { i.Notes = "notes carrying ntok-lff" }) + + labeled := seed("labeled", func(i *types.Issue) { i.Labels = []string{label} }) + unlabeled := seed("unlabeled", nil) + + parent := seed("parent", func(i *types.Issue) { i.IssueType = types.TypeEpic }) + child := seed("child", nil) + if err := fixture.AddDependency(ctx, &types.Dependency{IssueID: child, DependsOnID: parent, Type: types.DepParentChild}, "seed"); err != nil { + t.Fatalf("seed edge %s -> %s: %v", child, parent, err) + } + loose := seed("loose", nil) + + typeTask := seed("type-task", nil) + typeBug := seed("type-bug", func(i *types.Issue) { i.IssueType = types.TypeBug }) + typeChore := seed("type-chore", func(i *types.Issue) { i.IssueType = types.TypeChore }) + + specced := seed("specced", func(i *types.Issue) { i.SpecID = spec + "design.md" }) + unspecced := seed("unspecced", nil) + + extRow := seed("ext", func(i *types.Issue) { i.ExternalRef = &external }) + extOther := seed("ext-other", func(i *types.Issue) { + other := fixture.IssuePrefix + "-other-99" + i.ExternalRef = &other + }) + + pinned := seed("pinned", func(i *types.Issue) { i.Pinned = true }) + unpinned := seed("unpinned", nil) + + deferred := seed("deferred", func(i *types.Issue) { i.DeferUntil = &future }) + undeferred := seed("undeferred", nil) + + overdue := seed("overdue", func(i *types.Issue) { i.DueAt = &past }) + dueLater := seed("due-later", func(i *types.Issue) { i.DueAt = &future }) + closedOverdue := seed("closed-overdue", func(i *types.Issue) { + i.Status = types.StatusClosed + closedAt := time.Now().UTC().Truncate(time.Second).Add(-time.Hour) + i.ClosedAt = &closedAt + i.DueAt = &past + }) + noDue := seed("no-due", nil) + + swarm := seed("mol-swarm", func(i *types.Issue) { i.MolType = types.MolTypeSwarm }) + patrol := seed("mol-patrol", func(i *types.Issue) { i.MolType = types.MolTypePatrol }) + + stOpen := seed("st-open", nil) + stProgress := seed("st-progress", func(i *types.Issue) { i.Status = types.StatusInProgress }) + stBlocked := seed("st-blocked", func(i *types.Issue) { i.Status = types.StatusBlocked }) + stClosed := seed("st-closed", func(i *types.Issue) { + i.Status = types.StatusClosed + closedAt := time.Now().UTC().Truncate(time.Second).Add(-time.Hour) + i.ClosedAt = &closedAt + }) + statusScope := readerIDFilter(stOpen, stProgress, stBlocked, stClosed) + + molType := func(m types.MolType) *publicops.MolType { return &m } + scoped := func(ids ...string) publicops.ListRequest { + return publicops.ListRequest{IDFilter: readerIDFilter(ids...), AllFlag: true} + } + with := func(req publicops.ListRequest, mutate func(*publicops.ListRequest)) publicops.ListRequest { + mutate(&req) + return req + } + + for _, test := range []struct { + name string + req publicops.ListRequest + want []string + }{ + {"Priority is exact", with(scoped(p0, p2, p4), func(r *publicops.ListRequest) { r.Priority = intp(2) }), []string{p2}}, + {"Priority 0 is a value, not unset", with(scoped(p0, p2, p4), func(r *publicops.ListRequest) { r.Priority = intp(0) }), []string{p0}}, + {"PriorityMin is inclusive", with(scoped(p0, p2, p4), func(r *publicops.ListRequest) { r.PriorityMin = intp(2) }), []string{p2, p4}}, + {"PriorityMax is inclusive", with(scoped(p0, p2, p4), func(r *publicops.ListRequest) { r.PriorityMax = intp(2) }), []string{p0, p2}}, + {"PriorityMin and PriorityMax compose", with(scoped(p0, p2, p4), func(r *publicops.ListRequest) { r.PriorityMin, r.PriorityMax = intp(1), intp(3) }), []string{p2}}, + + {"TitleContains is a case-insensitive substring", with(scoped(textT, textD, textN), func(r *publicops.ListRequest) { r.TitleContains = "TTOK-LFF" }), []string{textT}}, + {"DescContains reads the description only", with(scoped(textT, textD, textN), func(r *publicops.ListRequest) { r.DescContains = "dtok-lff" }), []string{textD}}, + {"NotesContains reads the notes only", with(scoped(textT, textD, textN), func(r *publicops.ListRequest) { r.NotesContains = "ntok-lff" }), []string{textN}}, + {"EmptyDesc keeps the rows with no description", with(scoped(textT, textD, textN), func(r *publicops.ListRequest) { r.EmptyDesc = true }), []string{textT, textN}}, + + {"NoLabels keeps the unlabeled row", with(scoped(labeled, unlabeled), func(r *publicops.ListRequest) { r.NoLabels = true }), []string{unlabeled}}, + {"LabelPattern is a glob", with(scoped(labeled, unlabeled), func(r *publicops.ListRequest) { r.LabelPattern = fixture.IssuePrefix + "-scope-lff*" }), []string{labeled}}, + {"LabelRegex is a regular expression", with(scoped(labeled, unlabeled), func(r *publicops.ListRequest) { r.LabelRegex = "-scope-lffp.t$" }), []string{labeled}}, + + {"NoParent keeps the top-level rows", with(scoped(parent, child, loose), func(r *publicops.ListRequest) { r.NoParent = true }), []string{parent, loose}}, + + {"ExcludeTypes drops the named type", with(scoped(typeTask, typeBug, typeChore), func(r *publicops.ListRequest) { r.ExcludeTypes = []string{"bug"} }), []string{typeTask, typeChore}}, + {"ExcludeTypes takes a comma-separated value", with(scoped(typeTask, typeBug, typeChore), func(r *publicops.ListRequest) { r.ExcludeTypes = []string{"bug,chore"} }), []string{typeTask}}, + + {"SpecPrefix is a prefix", with(scoped(specced, unspecced), func(r *publicops.ListRequest) { r.SpecPrefix = spec }), []string{specced}}, + + {"ExternalContains is a case-insensitive substring", with(scoped(extRow, extOther), func(r *publicops.ListRequest) { r.ExternalContains = "lff-EXT" }), []string{extRow}}, + {"ExternalRef is exact", with(scoped(extRow, extOther), func(r *publicops.ListRequest) { r.ExternalRef = external }), []string{extRow}}, + + {"AllFlag alone admits both pinned-flag states", scoped(pinned, unpinned), []string{pinned, unpinned}}, + {"PinnedFlag selects the flagged row", publicops.ListRequest{IDFilter: readerIDFilter(pinned, unpinned), PinnedFlag: true}, []string{pinned}}, + {"NoPinnedFlag holds the unflagged predicate under AllFlag", with(scoped(pinned, unpinned), func(r *publicops.ListRequest) { r.NoPinnedFlag = true }), []string{unpinned}}, + + {"DeferredFlag keeps the deferred row", with(scoped(deferred, undeferred), func(r *publicops.ListRequest) { r.DeferredFlag = true }), []string{deferred}}, + + {"OverdueFlag keeps the open row past its due date", with(scoped(overdue, dueLater, closedOverdue, noDue), func(r *publicops.ListRequest) { r.OverdueFlag = true }), []string{overdue}}, + + {"ExcludeStatus under AllFlag keeps every status not named", with(scoped(stOpen, stProgress, stBlocked, stClosed), func(r *publicops.ListRequest) { r.ExcludeStatus = []string{"closed"} }), []string{stOpen, stProgress, stBlocked}}, + {"ExcludeStatus takes repeated and comma-separated values", with(scoped(stOpen, stProgress, stBlocked, stClosed), func(r *publicops.ListRequest) { r.ExcludeStatus = []string{"blocked,in_progress", " closed "} }), []string{stOpen}}, + {"ExcludeStatus adds to the default exclusions rather than replacing them", publicops.ListRequest{IDFilter: statusScope, ExcludeStatus: []string{"blocked"}}, []string{stOpen, stProgress}}, + {"ExcludeStatus narrows an explicit Status", publicops.ListRequest{IDFilter: statusScope, Status: "open,blocked,closed", ExcludeStatus: []string{"blocked"}}, []string{stOpen, stClosed}}, + + {"MolType is exact", with(scoped(swarm, patrol), func(r *publicops.ListRequest) { r.MolType = molType(types.MolTypeSwarm) }), []string{swarm}}, + } { + page, err := fixture.Reader.List(ctx, test.req) + if err != nil { + t.Errorf("List (%s): %v", test.name, err) + continue + } + assertReaderPageIDSet(t, "List ("+test.name+")", page, test.want) + } + + // An exclusion naming no status in the workspace vocabulary is refused, + // never an exclusion that silently excludes nothing. + if _, err := fixture.Reader.List(ctx, publicops.ListRequest{IDFilter: statusScope, ExcludeStatus: []string{"clsoed"}}); !errors.Is(err, publicops.ErrValidation) { + t.Errorf("List with ExcludeStatus naming an unknown status = %v, want an error wrapping ErrValidation", err) + } + + _, err := fixture.Reader.List(ctx, publicops.ListRequest{ + IDFilter: readerIDFilter(pinned, unpinned), PinnedFlag: true, NoPinnedFlag: true, + }) + if !errors.Is(err, publicops.ErrValidation) { + t.Errorf("List with PinnedFlag and NoPinnedFlag = %v, want an error wrapping ErrValidation", err) + } + + _, err = fixture.Reader.List(ctx, publicops.ListRequest{ + IDFilter: readerIDFilter(parent, child, loose), ParentID: parent, NoParent: true, + }) + if !errors.Is(err, publicops.ErrValidation) { + t.Errorf("List with ParentID and NoParent = %v, want an error wrapping ErrValidation", err) + } +} + +// sortedCopy returns its arguments as a sorted slice. +func sortedCopy(ids ...string) []string { + out := slices.Clone(ids) + slices.Sort(out) + return out +} + // readerIssue builds the seed every case starts from: an open, unassigned, // unblocked task that qualifies for ready work. A case that needs it to fail one // of those tests changes the field it means to test and nothing else. diff --git a/backend/conformance/retention_epoch_contract.go b/backend/conformance/retention_epoch_contract.go index 472b7a896..b2c0d100e 100644 --- a/backend/conformance/retention_epoch_contract.go +++ b/backend/conformance/retention_epoch_contract.go @@ -769,7 +769,21 @@ type EpochFixture struct { // Version now resolves to under the new epoch. A nil hook means this // backend cannot report that, and the case that needs it skips with // that reason. + // + // It only reads: it mints nothing and changes no state. It returns the + // address it was given when nothing carried the Version to a new one, + // and an error for an address the store does not serve. CurrentAddressFor func(ctx context.Context, storeID string, oldAddress Address) (Address, error) + + // LoseVersion records that storeID no longer serves the Version named by + // address. That address, and every address the same Version was carried + // to or from by a token-scheme change, resolves GoneReorganization from + // then on, in every later epoch: an epoch voids what the store lost, + // never what it still serves (R20-n). It is idempotent, never revives + // anything, and returns an error for an address storeID never minted. A + // nil LoseVersion means this backend cannot record a loss, and the cases + // that need one skip with that reason. + LoseVersion func(ctx context.Context, storeID string, address Address) error } // RunAnEpochBumpIsTriggeredOnlyByRestoreReinitOrSchemeChange pins R20-m: a @@ -819,94 +833,258 @@ func RunAnEpochBumpIsTriggeredOnlyByRestoreReinitOrSchemeChange(t *testing.T, ct // RunEpochBumpVoidsOnlyAddressesOfVersionsNoLongerServed pins R20-n — "Rev7 // tightening... the clause most likely to be gotten wrong" in the -// architecture doc's own words. A prior-epoch Address goes -// GoneReorganization UNLESS the backend still serves that Version, in which -// case it must stay Live AND additionally report the Address it now -// resolves to under the new epoch. +// architecture doc's own words: an epoch voids what the store lost, never +// what it still serves. // -// StillServes is an ORACLE here, not a control: this case cannot make a real -// backend keep serving one address and drop another, since Phase 0 wires no -// real backend. It asks StillServes what the fixture (once real) decided, -// and checks the rest of the contract's promise against that decision for -// both outcomes. +// Survival is RECORDED, never inferred (gastownhall/beads#6664, bee-ghosttrack +// review 5360880888, Major 1). An earlier form of this case made a Version +// survive by minting it again in every later epoch, and treated a Version +// nobody minted again as lost. That reads loss off the absence of a mint, so +// it could not express a Version the store lost after minting it, and it +// voided every survivor that nobody happened to mint again. Here a restore or +// a destructive reinit leaves every address row alone: an address the store +// still serves stays Live at its own address with no upkeep, and the only way +// an address goes Gone is LoseVersion saying so. +// +// Each phase is a named subtest, so a backend that cannot record a loss skips +// only the phases that need LoseVersion, and a failure names its phase. func RunEpochBumpVoidsOnlyAddressesOfVersionsNoLongerServed(t *testing.T, ctx context.Context, fixture EpochFixture) { t.Helper() - if fixture.MintUnderEpoch == nil { - t.Skip("this backend has no way to mint a Version under a known epoch (MintUnderEpoch is nil)") - } - if fixture.BumpEpoch == nil { - t.Skip("this backend has no epoch concept yet (BumpEpoch is nil)") - } - if fixture.StillServes == nil { - t.Skip("this backend cannot report whether it still serves a prior-epoch Version (StillServes is nil)") - } - if fixture.Resolve == nil { - t.Skip("this backend does not yet report retention state (Resolve is nil)") - } - if fixture.CurrentAddressFor == nil { - t.Skip("this backend cannot report a still-served Version's new Address (CurrentAddressFor is nil)") - } - store := epochStore(fixture, "voids") + epochSkipUnlessReady(t, fixture, false) - addrA, err := fixture.MintUnderEpoch(ctx, store, "record-a") - if err != nil { - t.Fatalf("MintUnderEpoch(record-a): %v", err) + // survivor-and-lost: of two Versions minted before a transition, the one + // the store loses goes Gone and the other stays Live at the address it + // already had, with no re-mint, for both triggers that leave addresses + // alone. + t.Run("survivor-and-lost", func(t *testing.T) { + if fixture.LoseVersion == nil { + t.Skip(epochLoseVersionSkip) + } + for _, trigger := range []EpochBumpTrigger{EpochBumpTriggerRestore, EpochBumpTriggerDestructiveReinit} { + t.Run(trigger.String(), func(t *testing.T) { + store := epochStore(fixture, "survivor-"+trigger.String()) + addrA := epochMintAddress(t, ctx, fixture, store, "record-a") + addrB := epochMintAddress(t, ctx, fixture, store, "record-b") + + newEpoch := epochBumpTo(t, ctx, fixture, store, trigger) + epochLoseAddress(t, ctx, fixture, store, addrB) + + epochRequireLive(t, ctx, fixture, store, addrA, newEpoch, + "record-a was never lost, so the transition leaves it served at its own address with no re-mint (R20-n's exception)") + epochRequireGone(t, ctx, fixture, store, addrB, newEpoch, + "record-b was lost, so the transition voids it (R20-n)") + + current := epochCurrentAddress(t, ctx, fixture, store, addrA) + epochRequireLive(t, ctx, fixture, store, current, newEpoch, + "the address CurrentAddressFor reports for a survivor must be served") + epochRequireLive(t, ctx, fixture, store, addrA, newEpoch, + "asking CurrentAddressFor must not retire or move the survivor's address") + + if lostCurrent, err := fixture.CurrentAddressFor(ctx, store, addrB); err == nil { + t.Errorf("CurrentAddressFor(a lost address) = %s with no error, want an error: a lost Version has no current address", lostCurrent) + } + epochRequireGone(t, ctx, fixture, store, addrB, newEpoch, + "CurrentAddressFor on a lost address must not bring it back") + }) + } + }) + + // gone-is-terminal: once an address is lost it stays lost. A later mint of + // the same id starts a new lineage under a new address, and neither that + // mint nor CurrentAddressFor revives the lost one (bee-ghosttrack's + // assertion for Major 1: a read-only lookup must not mint a replacement + // that makes a lost address look served). + t.Run("gone-is-terminal", func(t *testing.T) { + if fixture.LoseVersion == nil { + t.Skip(epochLoseVersionSkip) + } + store := epochStore(fixture, "terminal") + lost := epochMintAddress(t, ctx, fixture, store, "record-g") + epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerRestore) + epochLoseAddress(t, ctx, fixture, store, lost) + laterEpoch := epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerRestore) + + fresh := epochMintAddress(t, ctx, fixture, store, "record-g") + if fresh == lost { + t.Fatalf("MintUnderEpoch(record-g) returned %s, the address already lost: a lost address is never handed out again", lost) + } + epochRequireLive(t, ctx, fixture, store, fresh, laterEpoch, + "a fresh mint of the id is a new lineage and is served") + epochRequireGone(t, ctx, fixture, store, lost, laterEpoch, + "a later mint of the same id must not revive a lost address") + + if replacement, err := fixture.CurrentAddressFor(ctx, store, lost); err == nil { + t.Errorf("CurrentAddressFor(a lost address) = %s with no error, want an error: asking where a lost address resolves must not mint a replacement", replacement) + } + epochRequireGone(t, ctx, fixture, store, lost, laterEpoch, + "CurrentAddressFor on a lost address must not revive it") + + // Losing it a second time is a no-op that leaves the fresh lineage + // alone. + epochLoseAddress(t, ctx, fixture, store, lost) + epochRequireLive(t, ctx, fixture, store, fresh, laterEpoch, + "losing the old address again must leave the fresh lineage served") + }) + + // survival-needs-no-upkeep: with nothing lost, an address stays Live across + // any number of counter-only transitions without being minted again, and a + // later mint of the same id neither retires it nor revives anything. This + // is the phase the earlier, mint-driven form failed: it answered Gone for + // every survivor nobody minted again. + t.Run("survival-needs-no-upkeep", func(t *testing.T) { + store := epochStore(fixture, "upkeep") + kept := epochMintAddress(t, ctx, fixture, store, "record-c") + epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerRestore) + epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerDestructiveReinit) + finalEpoch := epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerRestore) + + epochRequireLive(t, ctx, fixture, store, kept, finalEpoch, + "nothing was lost, so three counter-only transitions leave the address served without a re-mint") + + fresh := epochMintAddress(t, ctx, fixture, store, "record-c") + if fresh == kept { + t.Fatalf("MintUnderEpoch(record-c) returned %s again after three bumps, want a new address for the new epoch", kept) + } + epochRequireLive(t, ctx, fixture, store, kept, finalEpoch, + "a later mint of the same id must not retire a served address") + epochRequireLive(t, ctx, fixture, store, fresh, finalEpoch, + "the fresh mint is served") + + current := epochCurrentAddress(t, ctx, fixture, store, kept) + epochRequireLive(t, ctx, fixture, store, current, finalEpoch, + "the current address of a survivor must be served") + epochRequireLive(t, ctx, fixture, store, kept, finalEpoch, + "asking for the current address must not change the survivor") + }) +} + +// RunTokenSchemeChangeCarriesLiveAddressesAndOnlyThose pins R20-n's retained +// mapping for the one trigger that changes how addresses are encoded. A +// token-scheme-change bump gives every Version the store still serves a new +// address under the new epoch and keeps the old address resolving, so a holder +// of the old address is neither stranded nor pointed at something else. A +// Version the store already lost gets no new address and stays Gone. +func RunTokenSchemeChangeCarriesLiveAddressesAndOnlyThose(t *testing.T, ctx context.Context, fixture EpochFixture) { + t.Helper() + epochSkipUnlessReady(t, fixture, true) + store := epochStore(fixture, "scheme-change") + + addrA := epochMintAddress(t, ctx, fixture, store, "record-a") + addrB := epochMintAddress(t, ctx, fixture, store, "record-b") + // record-b is lost in the epoch it was minted in, which a store may do. + epochLoseAddress(t, ctx, fixture, store, addrB) + + newEpoch := epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerTokenSchemeChange) + + epochRequireLive(t, ctx, fixture, store, addrA, newEpoch, + "record-a is still served after the scheme change, through the retained mapping") + epochRequireGone(t, ctx, fixture, store, addrB, newEpoch, + "record-b was lost before the scheme change, which must not carry it") + + carried := epochCurrentAddress(t, ctx, fixture, store, addrA) + if carried == addrA { + t.Errorf("CurrentAddressFor(%s) = the same address after a token-scheme change, want a new one: a scheme change re-encodes every served address, which is what tells a carry from a no-op", addrA) } - addrB, err := fixture.MintUnderEpoch(ctx, store, "record-b") - if err != nil { - t.Fatalf("MintUnderEpoch(record-b): %v", err) + epochRequireLive(t, ctx, fixture, store, carried, newEpoch, + "the carried address must be served under the new epoch") + epochRequireLive(t, ctx, fixture, store, addrA, newEpoch, + "the old address must keep resolving after its carried address is looked up") + + if again := epochCurrentAddress(t, ctx, fixture, store, carried); again != carried { + t.Errorf("CurrentAddressFor(%s) = %s, want the carried address itself: from the newest address the mapping is already current", carried, again) + } + if lostCurrent, err := fixture.CurrentAddressFor(ctx, store, addrB); err == nil { + t.Errorf("CurrentAddressFor(a lost address) = %s with no error, want an error: a lost Version is not carried", lostCurrent) + } +} + +// RunACarriedAddressKeepsResolvingAcrossLaterBumps pins that a carried mapping +// is recorded once and then simply persists: later counter-only transitions do +// not change it, and a second token-scheme change extends it to the newest +// address without breaking any older one. Every address of the Version points +// directly at the newest address (one hop from any member), never along a +// chain. +func RunACarriedAddressKeepsResolvingAcrossLaterBumps(t *testing.T, ctx context.Context, fixture EpochFixture) { + t.Helper() + epochSkipUnlessReady(t, fixture, false) + store := epochStore(fixture, "carried-later") + + addrA := epochMintAddress(t, ctx, fixture, store, "record-a") + epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerRestore) + epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerTokenSchemeChange) + addrA1 := epochCurrentAddress(t, ctx, fixture, store, addrA) + if addrA1 == addrA { + t.Fatalf("CurrentAddressFor(%s) = the same address after a token-scheme change, want a new one", addrA) } - newEpoch, err := fixture.BumpEpoch(ctx, store, EpochBumpTriggerRestore) - if err != nil { - t.Fatalf("BumpEpoch: %v", err) + // Two counter-only transitions, with nothing minted in between. + epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerRestore) + counterEpoch := epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerDestructiveReinit) + epochRequireLive(t, ctx, fixture, store, addrA, counterEpoch, + "the original address must still resolve after counter-only transitions") + epochRequireLive(t, ctx, fixture, store, addrA1, counterEpoch, + "the carried address must still resolve after counter-only transitions") + if got := epochCurrentAddress(t, ctx, fixture, store, addrA); got != addrA1 { + t.Errorf("CurrentAddressFor(%s) = %s, want %s: a counter-only transition does not change the mapping", addrA, got, addrA1) } - servesA, err := fixture.StillServes(ctx, store, addrA) - if err != nil { - t.Fatalf("StillServes(%s): %v", addrA, err) + // A second scheme change carries the Version again. + secondEpoch := epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerTokenSchemeChange) + addrA2 := epochCurrentAddress(t, ctx, fixture, store, addrA) + if addrA2 == addrA || addrA2 == addrA1 { + t.Fatalf("CurrentAddressFor(%s) = %s after a second scheme change, want an address different from %s and %s", addrA, addrA2, addrA, addrA1) } - servesB, err := fixture.StillServes(ctx, store, addrB) - if err != nil { - t.Fatalf("StillServes(%s): %v", addrB, err) + for _, member := range []Address{addrA, addrA1, addrA2} { + epochRequireLive(t, ctx, fixture, store, member, secondEpoch, + "every address of a carried Version must resolve after a second scheme change") } - if servesA == servesB { - t.Skip("this scenario needs one still-served and one no-longer-served address to exercise both halves of R20-n; StillServes reported the same answer for both, so this fixture gives this case nothing to contrast") + if got := epochCurrentAddress(t, ctx, fixture, store, addrA1); got != addrA2 { + t.Errorf("CurrentAddressFor(%s) = %s, want %s: every address of the Version points straight at the newest one", addrA1, got, addrA2) } - stillServed, noLongerServed := addrA, addrB - if servesB && !servesA { - stillServed, noLongerServed = addrB, addrA + finalEpoch := epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerRestore) + epochRequireLive(t, ctx, fixture, store, addrA2, finalEpoch, + "the newest carried address must still resolve after a later restore") +} + +// RunALostAddressStaysGoneAcrossASchemeChange pins that loss is terminal even +// across a token-scheme change. Losing a Version loses every address of its +// lineage at once, and a later scheme change must not carry a lost lineage +// back into service. +func RunALostAddressStaysGoneAcrossASchemeChange(t *testing.T, ctx context.Context, fixture EpochFixture) { + t.Helper() + epochSkipUnlessReady(t, fixture, true) + store := epochStore(fixture, "lost-scheme-change") + + addrA := epochMintAddress(t, ctx, fixture, store, "record-a") + epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerTokenSchemeChange) + addrA1 := epochCurrentAddress(t, ctx, fixture, store, addrA) + lostEpoch := epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerRestore) + + // One lineage, two addresses: losing either loses both. + epochLoseAddress(t, ctx, fixture, store, addrA) + epochRequireGone(t, ctx, fixture, store, addrA, lostEpoch, + "the original address of a lost Version must be Gone") + epochRequireGone(t, ctx, fixture, store, addrA1, lostEpoch, + "the carried address of a lost Version must be Gone too") + + schemeEpoch := epochBumpTo(t, ctx, fixture, store, EpochBumpTriggerTokenSchemeChange) + epochRequireGone(t, ctx, fixture, store, addrA, schemeEpoch, + "a later scheme change must not carry a lost lineage back into service") + epochRequireGone(t, ctx, fixture, store, addrA1, schemeEpoch, + "a later scheme change must not carry a lost lineage back into service") + for _, lostAddress := range []Address{addrA, addrA1} { + if current, err := fixture.CurrentAddressFor(ctx, store, lostAddress); err == nil { + t.Errorf("CurrentAddressFor(%s) = %s with no error, want an error: a lost lineage has no current address", lostAddress, current) + } } - voidedAnswer, err := fixture.Resolve(ctx, store, noLongerServed) - if err != nil { - t.Fatalf("Resolve(no-longer-served): %v", err) - } - if voidedAnswer.Restriction != RestrictionGoneReorganization { - t.Errorf("Resolve(a prior-epoch Address no longer served) = %s, want RestrictionGoneReorganization (R20-n)", voidedAnswer.Restriction) - } - if voidedAnswer.Epoch == nil { - t.Fatal("Resolve(a prior-epoch Address no longer served).Epoch = nil, want the current epoch populated (R20-n: the answer must name the current epoch, not just Restriction alone)") - } else if *voidedAnswer.Epoch != newEpoch { - t.Errorf("Resolve(a prior-epoch Address no longer served).Epoch = %d, want the current epoch %d", *voidedAnswer.Epoch, newEpoch) - } - - keptAnswer, err := fixture.Resolve(ctx, store, stillServed) - if err != nil { - t.Fatalf("Resolve(still-served): %v", err) - } - if keptAnswer.Restriction != RestrictionLive { - t.Errorf("Resolve(a prior-epoch Address the backend still serves) = %s, want RestrictionLive (R20-n's exception)", keptAnswer.Restriction) - } - - newAddr, err := fixture.CurrentAddressFor(ctx, store, stillServed) - if err != nil { - t.Fatalf("CurrentAddressFor(%s): %v", stillServed, err) - } - if newAddr == "" { - t.Error("CurrentAddressFor(a still-served prior-epoch Address) returned an empty Address, want a real one under the new epoch") + fresh := epochMintAddress(t, ctx, fixture, store, "record-a") + if fresh == addrA || fresh == addrA1 { + t.Fatalf("MintUnderEpoch(record-a) returned %s, an address of the lost lineage: a lost address is never handed out again", fresh) } + epochRequireLive(t, ctx, fixture, store, fresh, schemeEpoch, + "a fresh mint of the id after the loss is a new lineage and is served") } // --- fixture helpers ------------------------------------------------------- @@ -953,6 +1131,137 @@ func epochStore(fixture EpochFixture, tag string) string { return fixture.IssuePrefix + "-epoch-store-" + tag } +// epochLoseVersionSkip is the skip reason of every phase that needs +// EpochFixture.LoseVersion. +const epochLoseVersionSkip = "this backend cannot record that the store lost a Version (LoseVersion is nil)" + +// epochSkipUnlessReady skips the case when the fixture lacks a capability the +// epoch cases need. The cases that record a loss also need LoseVersion. The +// all-nil wiring test runs every case against an empty fixture, so each case +// must call this before it touches any of them. +func epochSkipUnlessReady(t *testing.T, fixture EpochFixture, needsLoseVersion bool) { + t.Helper() + if fixture.MintUnderEpoch == nil { + t.Skip("this backend has no way to mint a Version under a known epoch (MintUnderEpoch is nil)") + } + if fixture.BumpEpoch == nil { + t.Skip("this backend has no epoch concept yet (BumpEpoch is nil)") + } + if fixture.StillServes == nil { + t.Skip("this backend cannot report whether it still serves a prior-epoch Version (StillServes is nil)") + } + if fixture.Resolve == nil { + t.Skip("this backend does not yet report retention state (Resolve is nil)") + } + if fixture.CurrentAddressFor == nil { + t.Skip("this backend cannot report a still-served Version's new Address (CurrentAddressFor is nil)") + } + if needsLoseVersion && fixture.LoseVersion == nil { + t.Skip(epochLoseVersionSkip) + } +} + +// epochMintAddress mints id on store, failing the case if minting fails. +func epochMintAddress(t *testing.T, ctx context.Context, fixture EpochFixture, store, id string) Address { + t.Helper() + address, err := fixture.MintUnderEpoch(ctx, store, id) + if err != nil { + t.Fatalf("MintUnderEpoch(%s, %s): %v", store, id, err) + } + return address +} + +// epochBumpTo bumps store's epoch for trigger and returns the epoch it +// reports. Epochs are captured from the return value, never assumed: the +// counter is one per database, shared by every store the suite uses. +func epochBumpTo(t *testing.T, ctx context.Context, fixture EpochFixture, store string, trigger EpochBumpTrigger) int { + t.Helper() + epoch, err := fixture.BumpEpoch(ctx, store, trigger) + if err != nil { + t.Fatalf("BumpEpoch(%s, %s): %v", store, trigger, err) + } + return epoch +} + +// epochLoseAddress records that store lost the Version behind address. +func epochLoseAddress(t *testing.T, ctx context.Context, fixture EpochFixture, store string, address Address) { + t.Helper() + if err := fixture.LoseVersion(ctx, store, address); err != nil { + t.Fatalf("LoseVersion(%s, %s): %v", store, address, err) + } +} + +// epochCurrentAddress asks where address now resolves, failing the case on an +// error or an empty answer. +func epochCurrentAddress(t *testing.T, ctx context.Context, fixture EpochFixture, store string, address Address) Address { + t.Helper() + current, err := fixture.CurrentAddressFor(ctx, store, address) + if err != nil { + t.Fatalf("CurrentAddressFor(%s, %s): %v", store, address, err) + } + if current == "" { + t.Fatalf("CurrentAddressFor(%s, %s) returned an empty Address, want a real one", store, address) + } + return current +} + +// epochRequireLive asserts that address is served at epoch: StillServes is true +// and Resolve answers RestrictionLive naming that epoch. why says what the +// assertion is checking, for the failure message. +func epochRequireLive(t *testing.T, ctx context.Context, fixture EpochFixture, store string, address Address, epoch int, why string) { + t.Helper() + serves, err := fixture.StillServes(ctx, store, address) + if err != nil { + t.Fatalf("StillServes(%s): %v", address, err) + } + if !serves { + t.Errorf("StillServes(%s) = false, want true: %s", address, why) + } + answer, err := fixture.Resolve(ctx, store, address) + if err != nil { + t.Fatalf("Resolve(%s): %v", address, err) + } + if answer.Restriction != RestrictionLive { + t.Errorf("Resolve(%s) = %s, want RestrictionLive: %s", address, answer.Restriction, why) + } + epochRequireAnswerEpoch(t, answer, address, epoch, why) +} + +// epochRequireGone asserts that address is no longer served at epoch: +// StillServes is false and Resolve answers RestrictionGoneReorganization +// naming that epoch. +func epochRequireGone(t *testing.T, ctx context.Context, fixture EpochFixture, store string, address Address, epoch int, why string) { + t.Helper() + serves, err := fixture.StillServes(ctx, store, address) + if err != nil { + t.Fatalf("StillServes(%s): %v", address, err) + } + if serves { + t.Errorf("StillServes(%s) = true, want false: %s", address, why) + } + answer, err := fixture.Resolve(ctx, store, address) + if err != nil { + t.Fatalf("Resolve(%s): %v", address, err) + } + if answer.Restriction != RestrictionGoneReorganization { + t.Errorf("Resolve(%s) = %s, want RestrictionGoneReorganization: %s", address, answer.Restriction, why) + } + epochRequireAnswerEpoch(t, answer, address, epoch, why) +} + +// epochRequireAnswerEpoch asserts that a Live or Gone answer names the current +// epoch (R20-n: the answer carries the epoch, not just the Restriction). +func epochRequireAnswerEpoch(t *testing.T, answer RetentionAnswer, address Address, epoch int, why string) { + t.Helper() + if answer.Epoch == nil { + t.Errorf("Resolve(%s).Epoch = nil, want the current epoch %d: %s", address, epoch, why) + return + } + if *answer.Epoch != epoch { + t.Errorf("Resolve(%s).Epoch = %d, want the current epoch %d: %s", address, *answer.Epoch, epoch, why) + } +} + // sameRetentionAnswer compares two RetentionAnswer values by content rather // than identity, so a case can assert "this did not change" without // depending on the concrete Restriction the backend happened to pick. diff --git a/backend/conformance/role_bundle_cases.go b/backend/conformance/role_bundle_cases.go index ff52c67e4..1c5e2cf00 100644 --- a/backend/conformance/role_bundle_cases.go +++ b/backend/conformance/role_bundle_cases.go @@ -63,6 +63,7 @@ var roleContractCases = []roleContract{ RunBatchApplyCloseItemsAnswerToTheCloseGuards, RunBatchApplyRefusesADottedChildGatedOnItsOwnParent, RunBatchApplyAppliesTheDefaultPriority, + RunBatchApplyCarriesTheGateMembers, ), roleCases("BatchCloser", "BatchCloser()", oncePerRole, @@ -463,6 +464,8 @@ var roleContractCases = []roleContract{ RunLifecycleCreateWritesEveryScalarField, RunLifecycleCreateEchoesSubSecondTimestamps, RunLifecycleCreateAppliesTheDefaultPriority, + RunLifecycleCreateWritesTheGateMembers, + RunLifecycleCreateBoundsTheGateMembers, ), roleCases("LifecycleUpdate", "IssueLifecycle()", oncePerRole, @@ -494,6 +497,8 @@ var roleContractCases = []roleContract{ RunLifecycleUpdateProvenanceLabelsHistory, RunLifecycleUpdateRefusesATemplate, RunLifecycleUpdateAllowTemplateEditsATemplate, + RunLifecycleUpdatePatchesTheGateMembers, + RunLifecycleUpdateBoundsTheGateMembers, ), roleCases("Memories", "Memories()", oncePerRole, @@ -599,6 +604,8 @@ var roleContractCases = []roleContract{ RunReaderListWispTypeNarrowsTheAdmittedPlaneRatherThanAdmittingIt, RunReaderListBriefDropsTheFreeFormTextAndNothingElse, RunReaderReadyBriefDropsTheFreeFormTextAndNothingElse, + RunReaderListTimeBoundsAreStrictAndWholeSecond, + RunReaderListFilterFamiliesNarrowToTheirRows, ), roleCases("ReadyClaimer", "ReadyClaimer() and IssueReader()", oncePerRole, diff --git a/backend/conformance/versioned_history_wiring_test.go b/backend/conformance/versioned_history_wiring_test.go index 08eed2b53..b022b716e 100644 --- a/backend/conformance/versioned_history_wiring_test.go +++ b/backend/conformance/versioned_history_wiring_test.go @@ -129,5 +129,14 @@ func TestVersionedHistoryPhase0RunsInFullSkipMode(t *testing.T) { t.Run("EpochBumpVoidsOnlyAddressesOfVersionsNoLongerServed", func(t *testing.T) { RunEpochBumpVoidsOnlyAddressesOfVersionsNoLongerServed(t, ctx, fixture) }) + t.Run("TokenSchemeChangeCarriesLiveAddressesAndOnlyThose", func(t *testing.T) { + RunTokenSchemeChangeCarriesLiveAddressesAndOnlyThose(t, ctx, fixture) + }) + t.Run("ACarriedAddressKeepsResolvingAcrossLaterBumps", func(t *testing.T) { + RunACarriedAddressKeepsResolvingAcrossLaterBumps(t, ctx, fixture) + }) + t.Run("ALostAddressStaysGoneAcrossASchemeChange", func(t *testing.T) { + RunALostAddressStaysGoneAcrossASchemeChange(t, ctx, fixture) + }) }) } diff --git a/backend/conformance/versioned_read_contract.go b/backend/conformance/versioned_read_contract.go new file mode 100644 index 000000000..0e187117c --- /dev/null +++ b/backend/conformance/versioned_read_contract.go @@ -0,0 +1,356 @@ +package conformance + +import ( + "context" + "testing" + "time" +) + +// This file holds the contract for R7.1 (gastownhall/beads#6136, design doc +// gastownhall/beads#5898 revision 9): the as-of read — the "versioned +// reads" half of Phase 3's title, authored here from scratch, since no +// fixture for it exists anywhere in this package to un-skip. +// +// R7.1, VERBATIM (design doc #5898 rev 9): "An as-of read is a named read +// whose selector is an instant. Given an instant T or a version address, a +// store returns one Bead's durable state as of that point — the latest +// version it holds that was accepted at or before T, with everything later +// excluded — under R7's record shape, marking the address it served, or +// refuses as gone or unknown with the reason (R8, R20). Like every history +// answer it is complete for the answering store's holdings and may change +// after a sync (TC3)." +// +// ADDRESS, RESTRICTION, AND CHANGEATTRIBUTION ARE DECLARED IN +// expected_revision_contract.go — see that file's package-level note on +// where this suite's shared vocabulary lives and why. This file reuses +// Restriction's five values as-is for the gone-or-unknown refusal outcome +// (R8): an as-of read never invents a sixth state, and never distinguishes +// "gone" from "unknown" any differently than R20 already does. +// +// EVERY HOOK ON THE FIXTURE BELOW IS INDEPENDENTLY NILABLE — see the +// package-level note in expected_revision_contract.go. Every case +// nil-checks every hook it uses and SKIPS BY NAME when one is missing. No +// backend implements as-of reads yet — the implementation is +// the child this suite is written ahead of. +// +// EXPLICIT NON-GOAL: MEMORY-PLANE CONSUMER POLICY IS NOT PART OF THIS +// PRIMITIVE. R7.1's own text is explicit that a closed-before-T boundary, +// sibling exclusion, and supersession exclusion "are Memory-plane policies +// a consumer layers on this primitive (#5877), not part of it." This suite +// does not implement or assert any of the three — a future reader who finds +// them absent should read that as this file honoring R7.1's own scope, not +// as an oversight. This is the read-side analog of the R16/R16.1 boundary +// risk already recorded in expected_revision_contract.go: do not conflate +// the primitive with policy layered on top of it. +// +// THIS SUITE ASSERTS LOCAL COMPLETENESS ONLY (TC3). Nothing below requires, +// or even checks, that two stores asked about the same lineage agree — R7.1 +// itself says an as-of answer "may change after a sync," so two stores at +// different sync points are expected to answer differently, and neither is +// wrong. RunAsOfReadIsCompleteOnlyForTheAnsweringStoresHoldings is the one +// case that touches more than one store, and what it asserts is exactly +// this: each store answers strictly from its own holdings, never a +// sibling's — not that the two agree. + +// AsOfSelector names the point R7.1 resolves against: either a wall-clock +// instant, or a specific version Address treated as the selector itself — +// "the read that names its own answer" (R7.1: "an instant T or a version +// address"). Exactly one of At/Version is populated in every case this file +// exercises; R7.1 does not speak to the shape where both or neither are +// set, so this suite does not either. +type AsOfSelector struct { + At *time.Time + Version *Address +} + +// AsOfReadRefusal is R8's typed outcome for an as-of read that cannot be +// answered. Restriction is always one of the four Gone*/Unknown values, +// never RestrictionLive — a live answer is a served AsOfReadResult, not a +// refusal. Reason explains why (R8). +type AsOfReadRefusal struct { + Restriction Restriction + Reason string +} + +// AsOfReadResult is the outcome of an as-of read (R7.1). Address/State and +// Refusal are mutually exclusive: read Address/State only when Refusal is +// nil. +type AsOfReadResult struct { + // Address is the version this read served, marking "the address it + // served" (R7.1). Populated only when Refusal is nil. + Address Address + // State is the served version's durable state under R7's record shape. + // Opaque to this suite: the fixture adapter translates a backend's real + // record shape into this map, and no case here asserts its field-level + // content — only that a served result carries an Address. + State map[string]any + // Refusal is populated instead of Address/State when the read cannot be + // answered (R8). Nil means the read was served. + Refusal *AsOfReadRefusal +} + +// AsOfRead resolves storeID's answer to an as-of read against id's lineage, +// at selector (R7.1). +type AsOfRead func(ctx context.Context, storeID, id string, selector AsOfSelector) (AsOfReadResult, error) + +// AsOfReadFixture supplies the capability under test for R7.1: a read whose +// selector is an instant or a version address, resolving to the latest +// version accepted at or before that point, or a typed refusal. +type AsOfReadFixture struct { + IssuePrefix string + + // Resolve performs the as-of read under test (R7.1). A nil hook means + // this backend does not implement as-of reads yet, and every case in + // this file skips with that reason. + Resolve AsOfRead + + // MintAt mints a fresh version for id under storeID, recorded as + // accepted at the given instant, and returns its Address. Cases use + // this to build a lineage with known accept-times to resolve an as-of + // read against. A nil hook means this backend has no way to mint a + // version at a controlled accept-time, and cases that need one skip + // with that reason. + MintAt func(ctx context.Context, storeID, id string, acceptedAt time.Time) (Address, error) + + // MakeUnanswerable arranges for id to be unanswerable at storeID for + // the given Restriction (one of RestrictionGoneRetention/GoneErasure/ + // GoneReorganization/Unknown) — independently of + // RetentionFixture/EpochFixture's own removal machinery, since R7.1's + // refusal is a sibling contract to R17/R20, not a dependent of them. A + // nil hook means this backend has no way to arrange this, and the case + // that needs it skips with that reason. + MakeUnanswerable func(ctx context.Context, storeID, id string, restriction Restriction) error +} + +// RunAsOfReadSelectorAcceptsEitherAnInstantOrAVersionAddress pins R7.1's +// selector shape: an instant T and the version address that instant +// resolves to are two names for the same answer, and a store must accept +// either. +func RunAsOfReadSelectorAcceptsEitherAnInstantOrAVersionAddress(t *testing.T, ctx context.Context, fixture AsOfReadFixture) { + t.Helper() + if fixture.Resolve == nil { + t.Skip("this backend does not implement as-of reads (Resolve is nil)") + } + if fixture.MintAt == nil { + t.Skip("this backend has no way to mint a version at a controlled accept-time (MintAt is nil)") + } + store := asOfReadStore(fixture, "selector-kinds") + id := fixture.IssuePrefix + "-asof-selector" + t0 := time.Now().UTC().Add(-time.Hour) + asOfReadMint(t, ctx, fixture, store, id, t0) + t1 := t0.Add(time.Minute) + second := asOfReadMint(t, ctx, fixture, store, id, t1) + + byInstant, err := fixture.Resolve(ctx, store, id, AsOfSelector{At: &t1}) + if err != nil { + t.Fatalf("Resolve(selector=instant): %v", err) + } + if byInstant.Refusal != nil { + t.Fatalf("Resolve(selector=instant) = %+v, want a served result", byInstant) + } + + byVersion, err := fixture.Resolve(ctx, store, id, AsOfSelector{Version: &second}) + if err != nil { + t.Fatalf("Resolve(selector=version address): %v", err) + } + if byVersion.Refusal != nil { + t.Fatalf("Resolve(selector=version address) = %+v, want a served result", byVersion) + } + + if byInstant.Address != second { + t.Errorf("Resolve(selector=instant matching a version's own accept-time).Address = %s, want %s", byInstant.Address, second) + } + if byVersion.Address != second { + t.Errorf("Resolve(selector=version address).Address = %s, want the same address named %s", byVersion.Address, second) + } + if byInstant.Address != byVersion.Address { + t.Errorf("an instant selector (served %s) and a version-address selector naming the same version (served %s) resolved to different addresses; R7.1 accepts either as a name for the same answer", byInstant.Address, byVersion.Address) + } +} + +// RunAsOfReadReturnsTheLatestVersionAtOrBeforeTStrictlyExcludingLater pins +// R7.1's ordering promise: resolving at T returns the latest version +// accepted at or before T, and a version accepted after T is excluded even +// when its own instant is close by. +func RunAsOfReadReturnsTheLatestVersionAtOrBeforeTStrictlyExcludingLater(t *testing.T, ctx context.Context, fixture AsOfReadFixture) { + t.Helper() + if fixture.Resolve == nil { + t.Skip("this backend does not implement as-of reads (Resolve is nil)") + } + if fixture.MintAt == nil { + t.Skip("this backend has no way to mint a version at a controlled accept-time (MintAt is nil)") + } + store := asOfReadStore(fixture, "ordering") + id := fixture.IssuePrefix + "-asof-ordering" + t0 := time.Now().UTC().Add(-time.Hour) + asOfReadMint(t, ctx, fixture, store, id, t0) + t1 := t0.Add(time.Minute) + middle := asOfReadMint(t, ctx, fixture, store, id, t1) + t2 := t0.Add(2 * time.Minute) + asOfReadMint(t, ctx, fixture, store, id, t2) + + atExactly, err := fixture.Resolve(ctx, store, id, AsOfSelector{At: &t1}) + if err != nil { + t.Fatalf("Resolve(T=middle's own instant): %v", err) + } + if atExactly.Refusal != nil || atExactly.Address != middle { + t.Errorf("Resolve(T=middle's own instant) = %+v, want the version accepted exactly at T (%s), not a later one", atExactly, middle) + } + + between := t1.Add(30 * time.Second) + betweenResult, err := fixture.Resolve(ctx, store, id, AsOfSelector{At: &between}) + if err != nil { + t.Fatalf("Resolve(T strictly between two versions): %v", err) + } + if betweenResult.Refusal != nil || betweenResult.Address != middle { + t.Errorf("Resolve(T strictly between two versions) = %+v, want the latest version at-or-before T (%s); the version accepted after T must be strictly excluded", betweenResult, middle) + } +} + +// RunAsOfReadReportsTheAddressItServed pins R7.1's "marking the address it +// served": a served result names the exact Address of the version it +// returned, not merely a truthy success. +func RunAsOfReadReportsTheAddressItServed(t *testing.T, ctx context.Context, fixture AsOfReadFixture) { + t.Helper() + if fixture.Resolve == nil { + t.Skip("this backend does not implement as-of reads (Resolve is nil)") + } + if fixture.MintAt == nil { + t.Skip("this backend has no way to mint a version at a controlled accept-time (MintAt is nil)") + } + store := asOfReadStore(fixture, "reports-address") + id := fixture.IssuePrefix + "-asof-reports-address" + at := time.Now().UTC() + address := asOfReadMint(t, ctx, fixture, store, id, at) + + result, err := fixture.Resolve(ctx, store, id, AsOfSelector{At: &at}) + if err != nil { + t.Fatalf("Resolve: %v", err) + } + if result.Refusal != nil { + t.Fatalf("Resolve = %+v, want a served result", result) + } + if result.Address == "" { + t.Fatal("Resolve returned an empty Address on a served result, want the address of the version it served (R7.1)") + } + if result.Address != address { + t.Errorf("Resolve(...).Address = %s, want the served version's own address %s", result.Address, address) + } +} + +// RunAsOfReadRefusesAsGoneOrUnknownNeverSubstitutingAnotherVersion pins R8: +// a read that cannot be answered refuses as a typed Gone or Unknown outcome +// with a reason, and never silently returns a neighboring version, the +// nearest surviving version, or current state as a substitute — R8's own +// text names all three as non-answers. +func RunAsOfReadRefusesAsGoneOrUnknownNeverSubstitutingAnotherVersion(t *testing.T, ctx context.Context, fixture AsOfReadFixture) { + t.Helper() + if fixture.Resolve == nil { + t.Skip("this backend does not implement as-of reads (Resolve is nil)") + } + if fixture.MintAt == nil { + t.Skip("this backend has no way to mint a version at a controlled accept-time (MintAt is nil)") + } + if fixture.MakeUnanswerable == nil { + t.Skip("this backend has no way to make a lineage unanswerable (MakeUnanswerable is nil)") + } + + for _, restriction := range []Restriction{ + RestrictionGoneRetention, + RestrictionGoneErasure, + RestrictionGoneReorganization, + RestrictionUnknown, + } { + t.Run(restriction.String(), func(t *testing.T) { + store := asOfReadStore(fixture, "unanswerable-"+restriction.String()) + id := fixture.IssuePrefix + "-asof-unanswerable-" + restriction.String() + at := time.Now().UTC() + address := asOfReadMint(t, ctx, fixture, store, id, at) + + if err := fixture.MakeUnanswerable(ctx, store, id, restriction); err != nil { + t.Fatalf("MakeUnanswerable(%s, %s): %v", id, restriction, err) + } + + result, err := fixture.Resolve(ctx, store, id, AsOfSelector{At: &at}) + if err != nil { + t.Fatalf("Resolve after MakeUnanswerable(%s): %v", restriction, err) + } + if result.Refusal == nil { + t.Fatalf("Resolve after MakeUnanswerable(%s) = %+v, want a Refusal, not a served result (R8)", restriction, result) + } + if result.Refusal.Restriction != restriction { + t.Errorf("Refusal.Restriction = %s, want %s", result.Refusal.Restriction, restriction) + } + if result.Refusal.Reason == "" { + t.Error("Refusal.Reason is empty, want a reason (R8)") + } + if result.Address != "" { + t.Errorf("Resolve on a refusal returned Address = %s, want empty: R8 forbids silently substituting a neighboring version, the nearest surviving version, or current state (the pre-refusal address was %s)", result.Address, address) + } + }) + } +} + +// RunAsOfReadIsCompleteOnlyForTheAnsweringStoresHoldings pins R7.1's closing +// clause and TC3: an as-of answer "is complete for the answering store's +// holdings and may change after a sync." This case asserts NOTHING about +// agreement between two stores asked about the same lineage — proving that +// absence is the point, not a gap. It mints a lineage into exactly one of +// two stores and confirms each store answers strictly from its own +// holdings: the store that holds the lineage serves it, and the store that +// never received it answers Unknown (FR-06, reused from R20) rather than +// reaching across to a sibling store's knowledge, erroring, or answering +// Gone — which would claim knowledge of a lineage it never held. +func RunAsOfReadIsCompleteOnlyForTheAnsweringStoresHoldings(t *testing.T, ctx context.Context, fixture AsOfReadFixture) { + t.Helper() + if fixture.Resolve == nil { + t.Skip("this backend does not implement as-of reads (Resolve is nil)") + } + if fixture.MintAt == nil { + t.Skip("this backend has no way to mint a version at a controlled accept-time (MintAt is nil)") + } + holds := asOfReadStore(fixture, "tc3-holds-the-lineage") + neverSynced := asOfReadStore(fixture, "tc3-never-synced") + id := fixture.IssuePrefix + "-asof-tc3" + at := time.Now().UTC() + address := asOfReadMint(t, ctx, fixture, holds, id, at) + + local, err := fixture.Resolve(ctx, holds, id, AsOfSelector{At: &at}) + if err != nil { + t.Fatalf("Resolve on the store that holds the lineage: %v", err) + } + if local.Refusal != nil || local.Address != address { + t.Fatalf("Resolve on the store that holds the lineage = %+v, want it served from that store's own holdings (%s)", local, address) + } + + remote, err := fixture.Resolve(ctx, neverSynced, id, AsOfSelector{At: &at}) + if err != nil { + t.Fatalf("Resolve on a store that never received this lineage: %v", err) + } + if remote.Refusal == nil { + t.Fatalf("Resolve on a store that never received this lineage = %+v, want a Refusal: an as-of answer is complete for the answering store's own holdings, not a sibling's (TC3)", remote) + } + if remote.Refusal.Restriction != RestrictionUnknown { + t.Errorf("Refusal.Restriction on the never-synced store = %s, want RestrictionUnknown: no lineage knowledge is Unknown, not Gone (FR-06)", remote.Refusal.Restriction) + } +} + +// --- fixture helpers ------------------------------------------------------- + +// asOfReadStore names a storeID namespaced by the fixture's IssuePrefix and +// tag, so cases that need more than one store (e.g. the TC3 local- +// completeness case) get independent ones. +func asOfReadStore(fixture AsOfReadFixture, tag string) string { + return fixture.IssuePrefix + "-asof-store-" + tag +} + +// asOfReadMint mints a version for id on store at the given instant via +// fixture.MintAt, fataling the case if minting fails. +func asOfReadMint(t *testing.T, ctx context.Context, fixture AsOfReadFixture, store, id string, at time.Time) Address { + t.Helper() + address, err := fixture.MintAt(ctx, store, id, at) + if err != nil { + t.Fatalf("MintAt(%s, %s, %s): %v", store, id, at, err) + } + return address +} diff --git a/backend/http/BUILD.bazel b/backend/http/BUILD.bazel index dc6a908f1..f6359f820 100644 --- a/backend/http/BUILD.bazel +++ b/backend/http/BUILD.bazel @@ -31,9 +31,15 @@ go_test( timeout = "long", srcs = [ "attach_test.go", + "e2e_blocked_flags_test.go", + "e2e_blocked_test.go", "e2e_cli_test.go", "e2e_export_test.go", + "e2e_gates_test.go", + "e2e_heartbeat_test.go", + "e2e_link_test.go", "e2e_list_filters_test.go", + "e2e_list_page_edges_test.go", "e2e_mol_test.go", "e2e_promote_test.go", "e2e_read_your_own_write_test.go", @@ -61,6 +67,7 @@ go_test( "//internal/storage/backends", "//internal/storage/domain", "//internal/storage/embeddeddolt", + "//internal/storage/issueops", "//internal/testutil/bazeltest", ], ) diff --git a/backend/http/corpus/BUILD.bazel b/backend/http/corpus/BUILD.bazel index 537c3bdd1..ee8631077 100644 --- a/backend/http/corpus/BUILD.bazel +++ b/backend/http/corpus/BUILD.bazel @@ -11,6 +11,7 @@ go_test( srcs = [ "corpus_parts_test.go", "corpus_test.go", + "gate_check_served_test.go", "harness_test.go", "reference_proxy_test.go", "required_corpus_tier_test.go", @@ -24,6 +25,7 @@ go_test( "//internal/storage/domain", "//internal/storage/embeddeddolt", "//internal/testutil/bazeltest", + "//internal/types", "@in_gopkg_yaml_v3//:yaml_v3", ], ) @@ -41,8 +43,10 @@ go_test( # serial, ~242s together). The shapes are now dealt round robin across # corpusParts = 4 parts (corpus_test.go), each a top-level test with its own # server and seed, and served_pinned_shards.txt pins part k to shard k; the -# 5th shard runs the package's engine-free tests through the binary's -# round-robin. Each part pays the setup again, though it seeds the served +# 5th shard runs the package's other tests through the binary's +# round-robin (the engine-free ones, plus +# TestServedGateCheckOverAwaitTypedGates, which seeds its own small served +# store). Each part pays the setup again, though it seeds the served # and embedded sides concurrently (~62-76s on the lane's executors), so a # part's shard is that plus ~60s of shapes: 114-146s measured. Three parts # ran 170-180s each; they save one setup (~75 test-seconds a run) but diff --git a/backend/http/corpus/gate_check_served_test.go b/backend/http/corpus/gate_check_served_test.go new file mode 100644 index 000000000..60d9f82c0 --- /dev/null +++ b/backend/http/corpus/gate_check_served_test.go @@ -0,0 +1,355 @@ +//go:build cgo + +package corpus_test + +import ( + "context" + "encoding/json" + "net/http" + "os" + "path/filepath" + "slices" + "strings" + "sync" + "testing" + "time" + + "github.com/steveyegge/beads/internal/httpapi" + "github.com/steveyegge/beads/internal/storage/embeddeddolt" + "github.com/steveyegge/beads/internal/types" +) + +// gateCheckRequestLog records every request the reference proxy forwards. +type gateCheckRequestLog struct { + mu sync.Mutex + seen []string + next http.Handler +} + +func (l *gateCheckRequestLog) ServeHTTP(w http.ResponseWriter, r *http.Request) { + l.mu.Lock() + l.seen = append(l.seen, r.Method+" "+r.URL.Path) + l.mu.Unlock() + l.next.ServeHTTP(w, r) +} + +func (l *gateCheckRequestLog) take() []string { + l.mu.Lock() + defer l.mu.Unlock() + out := l.seen + l.seen = nil + return out +} + +func gateCheckWrites(reqs []string) []string { + var writes []string + for _, r := range reqs { + if !strings.HasPrefix(r, http.MethodGet+" ") { + writes = append(writes, r) + } + } + return writes +} + +// TestServedGateCheckOverAwaitTypedGates runs `bd gate check` over HTTP, through +// the reference proxy, against REAL await-typed gates, on a server that +// advertises neither gate token (issues.create.gates, issues.update.gates; the +// profile is masked here, so this holds whatever reference_server.json +// advertises). No create through it carries await_*: the gates are seeded +// straight into the served store before it listens, and every outcome is read +// back from that store: +// +// - --dry-run writes nothing; +// - an expired timer closes, a pending one stays open; +// - a bead gate whose target is open records its sighting (issues.update), +// and one whose target is closed closes; +// - a merged gh:pr gate closes, a closed one escalates and stays open; +// - a gh:run gate with a workflow-name hint discovers its run but cannot +// persist await_id through a server without issues.update.gates: the +// client refuses the patch before the dial, that gate's error names the +// missing token and the server, not a Go method, and await_id is +// untouched; +// - a persisted proto's gates are templates: listed, but no sweep evaluates +// or writes them, and they take no row of --limit (they sort first here). +// +// The corpus.yaml shapes prove the listing only (their gates have no +// await_type); this is the test that proves what the sweep does to the gates. +func TestServedGateCheckOverAwaitTypedGates(t *testing.T) { + skipUnlessEmbeddedDolt(t) + bin := buildBD(t) + ctx := context.Background() + + store, err := embeddeddolt.Open(ctx, t.TempDir(), corpusDatabase, "main") + if err != nil { + t.Fatalf("open the served store: %v", err) + } + t.Cleanup(func() { _ = store.Close() }) + if err := store.SetConfig(ctx, "issue_prefix", corpusPrefix); err != nil { + t.Fatalf("set the issue prefix: %v", err) + } + // The templates keep P0 and every other row gets P2, so the store's default + // order puts the template gates ahead of every live one. + seed := func(i *types.Issue) { + t.Helper() + i.Status = types.StatusOpen + i.Title = i.ID + if !i.IsTemplate { + i.Priority = 2 + } + if err := store.CreateIssue(ctx, i, "seed"); err != nil { + t.Fatalf("seed %s: %v", i.ID, err) + } + } + seed(&types.Issue{ID: "e2e-tgt-open", IssueType: "task"}) + seed(&types.Issue{ID: "e2e-tgt-closed", IssueType: "task"}) + if err := store.CloseIssue(ctx, "e2e-tgt-closed", "done", "seed", ""); err != nil { + t.Fatalf("close e2e-tgt-closed: %v", err) + } + seed(&types.Issue{ID: "e2e-g-timer", IssueType: "gate", AwaitType: "timer", Timeout: time.Millisecond}) + seed(&types.Issue{ID: "e2e-g-timer-pending", IssueType: "gate", AwaitType: "timer", Timeout: 100 * time.Hour}) + seed(&types.Issue{ID: "e2e-g-bead-open", IssueType: "gate", AwaitType: "bead", AwaitID: "e2e-tgt-open"}) + seed(&types.Issue{ID: "e2e-g-bead-closed", IssueType: "gate", AwaitType: "bead", AwaitID: "e2e-tgt-closed"}) + seed(&types.Issue{ID: "e2e-g-pr-merged", IssueType: "gate", AwaitType: "gh:pr", AwaitID: "11"}) + seed(&types.Issue{ID: "e2e-g-pr-closed", IssueType: "gate", AwaitType: "gh:pr", AwaitID: "12"}) + seed(&types.Issue{ID: "e2e-g-run-hint", IssueType: "gate", AwaitType: "gh:run", AwaitID: "ci-wf"}) + seed(&types.Issue{ID: "e2e-tpl-timer", IssueType: "gate", AwaitType: "timer", Timeout: time.Millisecond, IsTemplate: true}) + seed(&types.Issue{ID: "e2e-tpl-bead", IssueType: "gate", AwaitType: "bead", AwaitID: "e2e-tgt-open", IsTemplate: true}) + seed(&types.Issue{ID: "e2e-tpl-run", IssueType: "gate", AwaitType: "gh:run", AwaitID: "ci-wf", IsTemplate: true}) + + tokenFile := filepath.Join(t.TempDir(), "tokens") + if err := os.WriteFile(tokenFile, []byte(corpusToken+"\n"), 0o600); err != nil { + t.Fatalf("write the token file: %v", err) + } + auth, err := httpapi.NewTokenFileAuth(tokenFile) + if err != nil { + t.Fatalf("load the token file: %v", err) + } + cfg := corpusServeConfig(t, store) + cfg.AllowNonLoopback = true + cfg.Auth = auth + srv, err := httpapi.Listen(cfg) + if err != nil { + t.Fatalf("bind the in-process server: %v", err) + } + serveCtx, cancel := context.WithCancel(context.Background()) + done := make(chan struct{}) + go func() { defer close(done); _ = srv.Serve(serveCtx) }() + t.Cleanup(func() { + cancel() + select { + case <-done: + case <-time.After(30 * time.Second): + t.Error("the in-process server did not shut down") + } + }) + + // The gh:run case pins a server that cannot take an await_id patch, so the + // profile is held without issues.update.gates whatever + // reference_server.json advertises: upgrading the reference profile must + // not turn this case into a different test. + profile := loadReferenceProfile(t) + profile.Capabilities = slices.DeleteFunc(profile.Capabilities, func(c string) bool { return c == "issues.update.gates" }) + proxy := newReferenceProxy(t, profile, srv.Addr()) + reqs := &gateCheckRequestLog{next: proxy} + proxyAddr := startProxy(t, reqs) + + // gh and gt are fakes on PATH: gh answers the run discovery and the two PR + // states, gt records each escalation. + binDir := t.TempDir() + gh := `#!/bin/sh +case "$1 $2" in +"run list") echo '[{"databaseId":4242,"name":"ci-wf","status":"completed","conclusion":"success","createdAt":"2026-10-15T00:00:00Z","workflowName":"ci-wf"}]' ;; +"run view") echo '{"status":"completed","conclusion":"success","name":"ci-wf"}' ;; +"pr view") if [ "$3" = "11" ]; then echo '{"state":"MERGED","title":"m"}'; else echo '{"state":"CLOSED","title":"c"}'; fi ;; +*) echo "unexpected gh $*" >&2; exit 3 ;; +esac +` + if err := os.WriteFile(filepath.Join(binDir, "gh"), []byte(gh), 0o755); err != nil { + t.Fatalf("write fake gh: %v", err) + } + if err := os.WriteFile(filepath.Join(binDir, "gt"), []byte("#!/bin/sh\nexit 0\n"), 0o755); err != nil { + t.Fatalf("write fake gt: %v", err) + } + + dir := t.TempDir() + env := []string{ + "BEADS_HTTP_TOKEN=" + proxyAddr + "=" + corpusToken, + "BEADS_ACTOR=worker", + "BD_BACKUP_ENABLED=false", + "BD_EXPORT_AUTO=false", + "PATH=" + binDir + string(os.PathListSeparator) + os.Getenv("PATH"), + } + if r := runBD(t, bin, dir, env, "", "connect", "http://"+proxyAddr, "--expect-project-id", corpusProjectID, "--json"); r.code != 0 { + t.Fatalf("bd connect: %s", r) + } + reqs.take() + time.Sleep(50 * time.Millisecond) // the 1ms timer is expired by now + + get := func(id string) *types.Issue { + t.Helper() + issue, err := store.GetIssue(ctx, id) + if err != nil { + t.Fatalf("read %s back: %v", id, err) + } + return issue + } + wantStatus := func(id string, want types.Status) { + t.Helper() + if got := get(id).Status; got != want { + t.Errorf("%s status = %s, want %s", id, got, want) + } + } + seenOf := func(id string) string { + t.Helper() + var meta map[string]json.RawMessage + raw := get(id).Metadata + if len(raw) == 0 { + return "" + } + if err := json.Unmarshal(raw, &meta); err != nil { + t.Fatalf("%s metadata %s: %v", id, raw, err) + } + var seen string + _ = json.Unmarshal(meta["await_seen"], &seen) + return seen + } + allGates := []string{"e2e-g-timer", "e2e-g-timer-pending", "e2e-g-bead-open", "e2e-g-bead-closed", "e2e-g-pr-merged", "e2e-g-pr-closed", "e2e-g-run-hint"} + + t.Run("dry-run writes nothing", func(t *testing.T) { + r := runBD(t, bin, dir, env, "", "gate", "check", "--dry-run") + if r.code != 0 { + t.Fatalf("bd gate check --dry-run: %s", r) + } + if w := gateCheckWrites(reqs.take()); len(w) != 0 { + t.Fatalf("--dry-run sent writes %v\n%s", w, r) + } + for _, id := range allGates { + wantStatus(id, types.StatusOpen) + } + if seen := seenOf("e2e-g-bead-open"); seen != "" { + t.Errorf("--dry-run recorded a sighting %q", seen) + } + if got := get("e2e-g-run-hint").AwaitID; got != "ci-wf" { + t.Errorf("--dry-run persisted await_id %q", got) + } + }) + + t.Run("limit counts only live gates", func(t *testing.T) { + // bd gate list still lists templates, so its first three rows show the + // order the sweep's own listing would be cut from. + r := runBD(t, bin, dir, env, "", "gate", "list", "--limit", "3", "--json") + var listed []types.Issue + if start := strings.Index(r.stdout, "["); r.code != 0 || start < 0 || json.Unmarshal([]byte(r.stdout[start:]), &listed) != nil { + t.Fatalf("bd gate list --limit 3 --json: %s", r) + } + var ids []string + for _, g := range listed { + if strings.HasPrefix(g.ID, "e2e-tpl-") { + ids = append(ids, g.ID) + } + } + if len(listed) != 3 || len(ids) != 3 { + t.Fatalf("bd gate list --limit 3 listed %d gates, %d of them templates (%v), want the three template gates first", len(listed), len(ids), ids) + } + reqs.take() + + r = runBD(t, bin, dir, env, "", "gate", "check", "--dry-run", "--limit", "3") + if r.code != 0 { + t.Fatalf("bd gate check --dry-run --limit 3: %s", r) + } + if w := gateCheckWrites(reqs.take()); len(w) != 0 { + t.Fatalf("--dry-run sent writes %v\n%s", w, r) + } + if !strings.Contains(r.stdout, "Checked 3 gates") { + t.Errorf("--limit 3 behind three template gates must still check three live gates:\n%s", r) + } + if strings.Contains(r.stdout+r.stderr, "e2e-tpl-") { + t.Errorf("a template gate was checked:\n%s", r) + } + }) + + t.Run("timer sweep closes the expired timer", func(t *testing.T) { + r := runBD(t, bin, dir, env, "", "gate", "check", "--type=timer", "--escalate") + if r.code != 0 { + t.Fatalf("bd gate check --type=timer --escalate: %s", r) + } + reqs.take() + wantStatus("e2e-g-timer", types.StatusClosed) + wantStatus("e2e-g-timer-pending", types.StatusOpen) + wantStatus("e2e-tpl-timer", types.StatusOpen) + }) + + t.Run("bead sweep records the sighting and closes the done gate", func(t *testing.T) { + r := runBD(t, bin, dir, env, "", "gate", "check", "--type=bead") + if r.code != 0 { + t.Fatalf("bd gate check --type=bead: %s", r) + } + writes := gateCheckWrites(reqs.take()) + sighted := false + for _, w := range writes { + if strings.Contains(w, "e2e-g-bead-open") { + sighted = true + } + if strings.Contains(w, "e2e-tpl-bead") { + t.Errorf("the sweep wrote to the template gate: %s", w) + } + } + if !sighted { + t.Errorf("no write to e2e-g-bead-open reached the server; writes: %v\n%s", writes, r) + } + if seen := seenOf("e2e-g-bead-open"); seen != "e2e-tgt-open" { + t.Errorf("e2e-g-bead-open await_seen = %q, want e2e-tgt-open\n%s", seen, r) + } + if seen := seenOf("e2e-tpl-bead"); seen != "" { + t.Errorf("e2e-tpl-bead recorded a sighting %q; a template gate is never checked", seen) + } + wantStatus("e2e-g-bead-open", types.StatusOpen) + wantStatus("e2e-g-bead-closed", types.StatusClosed) + }) + + t.Run("gh:pr sweep closes the merged PR gate", func(t *testing.T) { + r := runBD(t, bin, dir, env, "", "gate", "check", "--type=gh:pr", "--escalate") + if r.code != 0 { + t.Fatalf("bd gate check --type=gh:pr --escalate: %s", r) + } + reqs.take() + wantStatus("e2e-g-pr-merged", types.StatusClosed) + wantStatus("e2e-g-pr-closed", types.StatusOpen) + if !strings.Contains(r.stdout, "e2e-g-pr-closed: ESCALATE") { + t.Errorf("closed PR gate was not escalated:\n%s", r) + } + }) + + t.Run("gh:run await_id persist refuses by the missing token", func(t *testing.T) { + r := runBD(t, bin, dir, env, "", "gate", "check", "--type=gh:run") + if r.code == 0 { + t.Fatalf("bd gate check --type=gh:run succeeded; the reference server does not advertise issues.update.gates: %s", r) + } + if w := gateCheckWrites(reqs.take()); len(w) != 0 { + t.Errorf("the refused await_id persist sent writes %v", w) + } + if !strings.Contains(r.stderr, "e2e-g-run-hint") || !strings.Contains(r.stderr, `does not advertise capability "issues.update.gates"`) { + t.Errorf("gh:run error does not name the gate and the missing issues.update.gates token:\n%s", r) + } + if !strings.Contains(r.stderr, "bd serve at http://"+proxyAddr) { + t.Errorf("gh:run error does not name the server it reached:\n%s", r) + } + if strings.Contains(r.stderr, "e2e-tpl-run") { + t.Errorf("the template gh:run gate was checked:\n%s", r) + } + // The capability refusal names the wire operation (updateIssue) that + // needs the token; the role and store methods stay out of it. + for _, leak := range []string{"UpdateIssue", "Lifecycle.Update"} { + if strings.Contains(r.stderr, leak) { + t.Errorf("gh:run error leaks %q:\n%s", leak, r) + } + } + if got := get("e2e-g-run-hint").AwaitID; got != "ci-wf" { + t.Errorf("e2e-g-run-hint await_id = %q, want ci-wf untouched", got) + } + wantStatus("e2e-g-run-hint", types.StatusOpen) + if got := get("e2e-tpl-run").AwaitID; got != "ci-wf" { + t.Errorf("e2e-tpl-run await_id = %q, want ci-wf untouched", got) + } + }) +} diff --git a/backend/http/corpus/harness_test.go b/backend/http/corpus/harness_test.go index 135499b25..d2a2c4d02 100644 --- a/backend/http/corpus/harness_test.go +++ b/backend/http/corpus/harness_test.go @@ -142,6 +142,10 @@ func corpusServeConfig(t *testing.T, s storage.DoltStorage) httpapi.Config { must("BatchGetter") cfg.LeaseReclaimer, err = s.LeaseReclaimer() must("LeaseReclaimer") + cfg.Heartbeater, err = s.Heartbeater() + must("Heartbeater") + cfg.BlockedLister, err = s.BlockedLister() + must("BlockedLister") cfg.Relations, err = s.IssueRelations() must("IssueRelations") cfg.Commenter, err = s.Commenter() diff --git a/backend/http/corpus/testdata/corpus.yaml b/backend/http/corpus/testdata/corpus.yaml index a0f1b5925..925d1db64 100644 --- a/backend/http/corpus/testdata/corpus.yaml +++ b/backend/http/corpus/testdata/corpus.yaml @@ -96,11 +96,18 @@ files: {"key": "t-ifa", "id": "e2e-t-ifa", "title": "target ifa", "type": "task", "assignee": "worker", "metadata": {"seeded": "keep"}}, {"key": "t-death", "id": "e2e-t-death", "title": "target death", "type": "task", "assignee": "worker"}, {"key": "t-rc", "id": "e2e-t-rc", "title": "target rc", "type": "task", "assignee": "worker"}, + {"key": "t-hb", "id": "e2e-t-hb", "title": "target hb", "type": "task"}, + {"key": "t-hb2", "id": "e2e-t-hb2", "title": "target hb2", "type": "task"}, + {"key": "t-hb3", "id": "e2e-t-hb3", "title": "target hb3", "type": "task"}, {"key": "t-boot", "id": "e2e-t-boot", "title": "target boot", "type": "task"}, {"key": "t-ro", "id": "e2e-t-ro", "title": "target reopen", "type": "task"}, {"key": "t-dr", "id": "e2e-t-dr", "title": "target dep remove", "type": "task", "deps": [{"target": "t-db"}]}, {"key": "t-dc", "id": "e2e-t-dc", "title": "cascade root", "type": "epic"}, - {"key": "t-dc.1", "id": "e2e-t-dc.1", "title": "cascade child", "type": "task", "parent_key": "t-dc"} + {"key": "t-dc.1", "id": "e2e-t-dc.1", "title": "cascade child", "type": "task", "parent_key": "t-dc"}, + {"key": "t-gcr", "id": "e2e-t-gcr", "title": "target gate create", "type": "task"}, + {"key": "t-gct", "id": "e2e-t-gct", "title": "target gate check", "type": "task"}, + {"key": "t-gw", "id": "e2e-t-gw", "title": "target gate waiter", "type": "gate"}, + {"key": "t-gaw", "id": "e2e-t-gaw", "title": "target gate await id", "type": "gate"} ]} - name: bulk-ready-a.json bulk: {id_prefix: e2e-bra, count: 60, priority: 3, metadata: {gc.routed_to: pool-a}} @@ -301,6 +308,39 @@ shapes: source: mc skills/pr-review (list --all --id --json --limit) args: [list, --all, --id, "e2e-r1,e2e-a1", --json, --limit, "0"] pending: {slice: "SRV-1", reason: "S15b sends --id as listIssues id behind issues.list.ids, which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_ListScopeFiltersOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: gc-polecat-title-contains + source: gascity core formulas/mol-polecat-base.toml (list --title-contains --status a,b,c --json) + args: [list, --title-contains, "Routed", --status, "open,in_progress,blocked", --json] + pending: {slice: "SRV-1", reason: "--title-contains folds onto listIssues title behind issues.list.title, which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_ListScopeFiltersOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: gc-polecat-title-contains-closed-after + source: gascity core formulas/mol-polecat-base.toml (pre-flight 3d, list --title-contains --status closed --closed-after DATE --json) + args: [list, --title-contains, "closed task", --status, closed, --closed-after, "2000-01-01", --json] + pending: {slice: "SRV-1", reason: "needs issues.list.title (--title-contains folds onto listIssues title) and issues.list.filters (closed_after), which the reference server does not advertise, so the client refuses before dialing; remove the mark when reference_server.json is upgraded"} + - id: gc-polecat-closed-after + source: gascity core formulas/mol-polecat-base.toml:267 (list --title-contains --status closed --closed-after --json) + args: [list, --title-contains, "task", --status, closed, --closed-after, "2000-01-01", --json] + compare: ids + pending: {slice: "SRV-1", reason: "needs issues.list.title (--title-contains folds onto listIssues title) and issues.list.filters (closed_after), which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_ListFilterParityOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: wf-session-cleanup + source: an order cleanup script's closed-session sweep (list --all --include-infra --include-gates --status closed --label --closed-before --updated-before) + args: [list, --json, --all, --include-infra, --include-gates, --status, closed, --label, "lane:a", --closed-before, "2100-01-01T00:00:00Z", --updated-before, "2100-01-01T00:00:00Z", --limit, "0"] + compare: ids + pending: {slice: "SRV-1", reason: "needs issues.list.filters, which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_ListFilterParityOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: list-filter-priority-range + source: bd list --priority-min/--priority-max (listing filter parity) + args: [list, --json, --priority-min, "1", --priority-max, "3", --limit, "0"] + compare: ids + pending: {slice: "SRV-1", reason: "needs issues.list.filters, which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_ListFilterParityOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: list-filter-exclude-type-no-parent + source: bd list --exclude-type --no-parent (listing filter parity) + args: [list, --json, --exclude-type, epic, --no-parent, --limit, "0"] + compare: ids + pending: {slice: "SRV-1", reason: "needs issues.list.filters, which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_ListFilterParityOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: list-filter-updated-after + source: bd list --updated-after (listing filter parity) + args: [list, --json, --updated-after, "2000-01-01", --limit, "0"] + compare: ids + pending: {slice: "SRV-1", reason: "needs issues.list.filters, which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_ListFilterParityOverHTTP); remove the mark when reference_server.json is upgraded"} - id: mc-list-assignee-status source: mc review summaries (list --assignee --json --limit --status) args: [list, --assignee, alice, --json, --limit, "10", --status, open] @@ -364,7 +404,23 @@ shapes: - id: gc-blocked source: gc bdstore_ready_projection.go fetchReadyProjectionViaBlocked args: [blocked, --json] - pending: {slice: "S18", reason: "bd blocked hits the GetBlockedIssues stub (B3 #10)"} + pending: {slice: "SRV-1", reason: "bd blocked dials listBlockedIssues behind blocked.list, which the reference server does not advertise, so the client refuses at its capability preflight (pinned passing against the current server by backend/http TestE2E_BlockedOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: gc-blocked-flags + source: gc bdstore_ready_projection.go readiness door (bd blocked --flags --json, ids on stdin) + args: [blocked, --flags, --json] + stdin: "e2e-mol\ne2e-mol.1\ne2e-mol.2\ne2e-no-such-row\n" + compare: json + pending: {slice: "SRV-1", reason: "bd blocked --flags reads listBlockingAnnotations is_blocked behind dependencies.blocking.isBlocked, which the reference server does not advertise, so the client refuses at its capability preflight (pinned passing against the current server by backend/http TestE2E_BlockedFlagsOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: gc-blocked-flags-raw + source: gc bdstore_ready_projection.go readiness door (the stored is_blocked column, bd blocked --flags --raw --json, ids on stdin) + args: [blocked, --flags, --raw, --json] + stdin: "e2e-mol\ne2e-mol.1\ne2e-mol.2\ne2e-no-such-row\n" + compare: json + pending: {slice: "SRV-1", reason: "bd blocked --flags reads listBlockingAnnotations is_blocked behind dependencies.blocking.isBlocked, which the reference server does not advertise, so the client refuses at its capability preflight (pinned passing against the current server by backend/http TestE2E_BlockedFlagsOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: gc-blocked-parent + source: bd blocked --parent (the molecule-scoped blocked listing) + args: [blocked, --json, --parent, e2e-mol] + pending: {slice: "SRV-1", reason: "bd blocked dials listBlockedIssues behind blocked.list, which the reference server does not advertise, so the client refuses at its capability preflight (pinned passing against the current server by backend/http TestE2E_BlockedOverHTTP); remove the mark when reference_server.json is upgraded"} # ---------------------------------------------------------------- molecules - id: mc-mol-current @@ -441,6 +497,24 @@ shapes: - id: mc-gate-list-all source: core pack orders (gate list --all) args: [gate, list, --all, --json] + # gate check lists the open gates through the same ListGates entry. No + # seeded gate carries an await type (the seed graph carries no gate members; + # mc-gate-check-timer-resolves below creates a real timer gate), so the + # typed sweeps find nothing of their type and the untyped one lists the open + # gates and evaluates none: the listing is what these shapes prove served, + # and nothing resolves, escalates (no gt exec) or writes. + - id: mc-gate-check-timer + source: gc core pack gate-sweep.sh (bd gate check --type=timer --escalate) + args: [gate, check, --type=timer, --escalate] + compare: text + - id: mc-gate-check-gh + source: gc core pack gate-sweep.sh (bd gate check --type=gh --escalate) + args: [gate, check, --type=gh, --escalate] + compare: text + - id: gate-check-all + source: bd gate check (every open gate) + args: [gate, check] + compare: text - id: gc-export-all source: gc core pack reaper (gc bd export --all -o F) @@ -693,6 +767,35 @@ shapes: compare: exit verify: [[show, --json, e2e-t-rc]] pending: {slice: "SRV-1", reason: "the reference server does not advertise issues.reclaim (B3 #12), so the client refuses at its capability preflight"} + - id: gc-heartbeat + source: gc formulas/mol-do-work.toml:47 (gc bd heartbeat -> bd heartbeat) + setup: [[update, e2e-t-hb, --claim]] + args: [heartbeat, e2e-t-hb, --json] + verify: [[show, --json, e2e-t-hb]] + pending: {slice: "reference-server-heartbeat", reason: "the reference server does not advertise issues.heartbeat, so the client refuses at its capability preflight; pinned passing by backend/http TestE2E_HeartbeatOverHTTP; remove the mark when reference_server.json is upgraded"} + - id: gc-heartbeat-non-holder + source: gc formulas/mol-do-work.toml:47 (a worker heartbeating a bead another actor holds) + setup: [[update, e2e-t-hb2, --claim, --actor, alice]] + args: [heartbeat, e2e-t-hb2] + expect_exit: 1 + expect_stderr: "(?i)claimed by|alice" + compare: exit + pending: {slice: "reference-server-heartbeat", reason: "the reference server does not advertise issues.heartbeat, so the client refuses at its capability preflight; pinned passing by backend/http TestE2E_HeartbeatOverHTTP; remove the mark when reference_server.json is upgraded"} + - id: gc-heartbeat-closed + source: gc formulas/mol-do-work.toml:47 (a worker heartbeating a bead that was closed under it) + setup: [[update, e2e-t-hb3, --claim], [close, e2e-t-hb3]] + args: [heartbeat, e2e-t-hb3] + expect_exit: 1 + expect_stderr: "(?i)status closed|is closed" + compare: exit + pending: {slice: "reference-server-heartbeat", reason: "the reference server does not advertise issues.heartbeat, so the client refuses at its capability preflight; pinned passing by backend/http TestE2E_HeartbeatOverHTTP; remove the mark when reference_server.json is upgraded"} + - id: gc-heartbeat-wisp + source: gc formulas/mol-do-work.toml:47 (a heartbeat on a wisp, which is never leased) + args: [heartbeat, e2e-wisp-2] + expect_exit: 1 + expect_stderr: "(?i)ephemeral" + compare: exit + pending: {slice: "reference-server-heartbeat", reason: "the reference server does not advertise issues.heartbeat, so the client refuses at its capability preflight; pinned passing by backend/http TestE2E_HeartbeatOverHTTP; remove the mark when reference_server.json is upgraded"} - id: mc-promote source: mc mol-normalized-issue-pr-v1 (promote --reason) args: [promote, e2e-wisp-p, --reason, "keep it"] @@ -747,3 +850,33 @@ shapes: expect_exit: 1 expect_stderr: 'unknown command "meta"' compare: exit + # ---------------------------------------------------------------- gates + # The gate writes: create (one createIssue carrying the gate members and the + # blocks edge), a real timer gate resolving under gate check, add-waiter (a + # guarded waiters patch) and update --await-id. A --timeout=1ns timer is + # expired by the time gate check runs, so the resolution is deterministic. + - id: mc-gate-create-timer + source: core formulas / gate-sweep (bd gate create --type=timer --timeout --blocks) + args: [gate, create, --type=timer, --timeout=1ns, --blocks, e2e-t-gcr, --json] + ignore_fields: [id] # each side mints its own gate id + pending: {slice: "SRV-1", reason: "bd gate create sends the gate members on createIssue behind issues.create.gates, which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_GatesOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: mc-gate-check-timer-resolves + source: core gate-sweep.sh (gate check --type=timer --escalate) over a real timer gate + setup: [[gate, create, --type=timer, --timeout=1ns, --blocks, e2e-t-gct]] + args: [gate, check, --type=timer, --escalate] + compare: exit + verify: [[ready, --json, --limit, "0"]] # e2e-t-gct is ready on both sides + ignore_fields: [depends_on_id] # its (closed) gate's id is minted per workspace + pending: {slice: "SRV-1", reason: "the setup bd gate create sends the gate members on createIssue behind issues.create.gates, which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_GatesOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: mc-gate-add-waiter + source: bd done --phase-complete (gate add-waiter) + args: [gate, add-waiter, e2e-t-gw, "rig/workers/a"] + compare: text + verify: [[show, --json, e2e-t-gw]] + pending: {slice: "SRV-1", reason: "bd gate add-waiter sends waiters on updateIssue behind issues.update.gates, which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_GatesOverHTTP); remove the mark when reference_server.json is upgraded"} + - id: mc-update-await-id + source: gate discover / gate check gh:run persist (update --await-id) + args: [update, e2e-t-gaw, --await-id, "12345", --json] + compare: exit + verify: [[show, --json, e2e-t-gaw]] + pending: {slice: "SRV-1", reason: "bd update --await-id sends await_id on updateIssue behind issues.update.gates, which the reference server does not advertise, so the client refuses before dialing (pinned passing against the current server by backend/http TestE2E_GatesOverHTTP); remove the mark when reference_server.json is upgraded"} diff --git a/backend/http/e2e_blocked_flags_test.go b/backend/http/e2e_blocked_flags_test.go new file mode 100644 index 000000000..1943bd676 --- /dev/null +++ b/backend/http/e2e_blocked_flags_test.go @@ -0,0 +1,287 @@ +//go:build cgo + +package bdhttp_test + +import ( + "context" + "encoding/json" + "errors" + "os/exec" + "reflect" + "sort" + "strings" + "testing" + + "github.com/steveyegge/beads/internal/storage/issueops" +) + +// runBDStdin is runBD with stdin. +func runBDStdin(t *testing.T, f *remoteRolesFixture, stdin string, args ...string) bdResult { + t.Helper() + cmd := exec.Command(f.bin, args...) + cmd.Dir = f.dir + cmd.Env = minimalBDEnv(f.dir) + cmd.Stdin = strings.NewReader(stdin) + var o, e strings.Builder + cmd.Stdout, cmd.Stderr = &o, &e + err := cmd.Run() + code := 0 + var exitErr *exec.ExitError + if errors.As(err, &exitErr) { + code = exitErr.ExitCode() + } else if err != nil { + t.Fatalf("run bd %v: %v", args, err) + } + return bdResult{stdout: o.String(), stderr: e.String(), code: code} +} + +type blockedFlagRow struct { + ID string `json:"id"` + IsBlocked bool `json:"is_blocked"` +} + +func parseBlockedFlags(t *testing.T, out string) []blockedFlagRow { + t.Helper() + var rows []blockedFlagRow + if err := json.Unmarshal([]byte(strings.TrimSpace(out)), &rows); err != nil { + t.Fatalf("parse bd blocked --flags --json: %v\n%s", err, out) + } + if rows == nil { + t.Fatalf("bd blocked --flags --json printed null, want an array: %s", out) + } + return rows +} + +// flagStdin is every id the fixture created, in title order, plus an id that +// names no row, a blank line and a repeat: the omitted, ignored and collapsed +// cases. +func flagStdin(f *remoteRolesFixture) string { + titles := make([]string, 0, len(f.ids)) + for title := range f.ids { + titles = append(titles, title) + } + sort.Strings(titles) + var b strings.Builder + for _, title := range titles { + b.WriteString(f.ids[title] + "\n") + } + b.WriteString("\n " + f.ids[titles[0]] + " \ne2e-no-such-row\n") + return b.String() +} + +// TestE2E_BlockedFlagsOverHTTP runs `bd blocked --flags --json` (the blocked +// flag per id read from stdin, the readiness column gc projects) through the +// real `bd` binary against an in-process `bd serve` and against a local +// embedded workspace holding the same graph, and requires the same JSON once +// each generated id is mapped to its title. Over HTTP the read is +// listBlockingAnnotations with is_blocked; an older server's handshake is +// refused before the dial, naming dependencies.blocking.isBlocked. +// +// It also pins that this is the FLAG and not the listing: a row whose stored +// flag is set with no nameable blocker reads true here and is absent from +// `bd blocked --json`. +func TestE2E_BlockedFlagsOverHTTP(t *testing.T) { + skipUnlessEmbeddedDolt(t) + bin := buildBD(t) + + seed := func(f *remoteRolesFixture) { + f.seed() + blocker := f.create("blocker", "-t", "task") + gp := f.create("gate-parent", "-t", "epic") + kid := f.create("gate-kid", "-t", "task") + f.mustRun(nil, "dep", "add", kid, gp, "--type", "parent-child") + f.mustRun(nil, "dep", "add", gp, blocker) + } + + t.Run("served equals local", func(t *testing.T) { + addr := startE2EServer(t) + local := newEmbeddedFixture(t, bin) + seed(local) + served := newHTTPFixture(t, bin, addr) + seed(served) + + lr := runBDStdin(t, local, flagStdin(local), "blocked", "--flags", "--json") + sr := runBDStdin(t, served, flagStdin(served), "blocked", "--flags", "--json") + if lr.code != 0 || sr.code != 0 { + t.Fatalf("exit local=%d served=%d\nlocal: %s %s\nserved: %s %s", lr.code, sr.code, lr.stdout, lr.stderr, sr.stdout, sr.stderr) + } + normalize := func(f *remoteRolesFixture, rows []blockedFlagRow) []blockedFlagRow { + titleOf := map[string]string{} + for title, id := range f.ids { + titleOf[id] = title + } + out := make([]blockedFlagRow, 0, len(rows)) + for _, row := range rows { + if title, ok := titleOf[row.ID]; ok { + row.ID = title + } + out = append(out, row) + } + return out + } + want := normalize(local, parseBlockedFlags(t, lr.stdout)) + got := normalize(served, parseBlockedFlags(t, sr.stdout)) + if !reflect.DeepEqual(want, got) { + t.Errorf("served bd blocked --flags --json differs from the local command:\nlocal: %v\nserved: %v", want, got) + } + if len(want) != len(local.ids) { + t.Errorf("local answered %d rows for %d ids (the unknown id omitted, the repeat collapsed): %v", len(want), len(local.ids), want) + } + blocked := map[string]bool{} + for _, row := range got { + blocked[row.ID] = row.IsBlocked + } + for title, wantBlocked := range map[string]bool{ + "loner": true, "child-x": true, "gate-parent": true, "gate-kid": true, + "blocker": false, "child-b": false, "parent": false, + } { + if blocked[title] != wantBlocked { + t.Errorf("%s is_blocked = %v, want %v (rows %v)", title, blocked[title], wantBlocked, got) + } + } + // Byte-for-byte the same members in the same order. + if strings.Count(lr.stdout, "\n") != strings.Count(sr.stdout, "\n") { + t.Errorf("line counts differ:\nlocal:\n%s\nserved:\n%s", lr.stdout, sr.stdout) + } + // Nothing piped is an empty array. + if r := runBDStdin(t, served, "", "blocked", "--flags", "--json"); r.code != 0 || strings.TrimSpace(r.stdout) != "[]" { + t.Errorf("empty stdin: exit %d stdout %q, want [] and exit 0", r.code, r.stdout) + } + // The listing's filters are refused, not silently ignored. + if r := runBDStdin(t, served, "x\n", "blocked", "--flags", "--json", "--label", "a"); r.code != 1 { + t.Errorf("--flags --label exited %d, want 1: %s", r.code, r.stdout) + } + }) + + t.Run("the flag, not the listing", func(t *testing.T) { + addr, reference := startE2EServerWithStore(t, e2eProjectID, e2eDatabase) + served := newHTTPFixture(t, bin, addr) + stale := served.create("stale") + if err := reference.RunEventsMaintenanceTx(context.Background(), func(ctx context.Context, tx issueops.DBTX) error { + _, err := tx.ExecContext(ctx, "UPDATE issues SET is_blocked = 1 WHERE id = ?", stale) + return err + }); err != nil { + t.Fatalf("set the stale flag: %v", err) + } + rows := parseBlockedFlags(t, runBDStdin(t, served, stale+"\n", "blocked", "--flags", "--json").stdout) + if len(rows) != 1 || rows[0].ID != stale || !rows[0].IsBlocked { + t.Errorf("--flags for a stale-flagged row = %v, want [{%s true}]", rows, stale) + } + listing := served.mustRun(nil, "blocked", "--json").stdout + if strings.Contains(listing, stale) { + t.Errorf("bd blocked --json lists %s, which has no nameable blocker: %s", stale, listing) + } + }) + + t.Run("raw is the stored column", func(t *testing.T) { + addr, reference := startE2EServerWithStore(t, e2eProjectID, e2eDatabase) + local := newEmbeddedFixture(t, bin) + seed(local) + served := newHTTPFixture(t, bin, addr) + seed(served) + + flagsOf := func(f *remoteRolesFixture, stdin string, args ...string) map[string]bool { + t.Helper() + r := runBDStdin(t, f, stdin, append([]string{"blocked", "--flags", "--json"}, args...)...) + if r.code != 0 { + t.Fatalf("bd blocked --flags --json %v exited %d: %s %s", args, r.code, r.stdout, r.stderr) + } + titleOf := map[string]string{} + for title, id := range f.ids { + titleOf[id] = title + } + out := map[string]bool{} + for _, row := range parseBlockedFlags(t, r.stdout) { + key := row.ID + if title, ok := titleOf[row.ID]; ok { + key = title + } + out[key] = row.IsBlocked + } + return out + } + + localRaw := flagsOf(local, flagStdin(local), "--raw") + servedRaw := flagsOf(served, flagStdin(served), "--raw") + if !reflect.DeepEqual(localRaw, servedRaw) { + t.Errorf("served --raw differs from local --raw:\nlocal: %v\nserved: %v", localRaw, servedRaw) + } + lr := runBDStdin(t, local, flagStdin(local), "blocked", "--flags", "--json", "--raw") + sr := runBDStdin(t, served, flagStdin(served), "blocked", "--flags", "--json", "--raw") + if strings.Count(lr.stdout, "\n") != strings.Count(sr.stdout, "\n") { + t.Errorf("--raw line counts differ:\nlocal:\n%s\nserved:\n%s", lr.stdout, sr.stdout) + } + + // child-x is blocked ONLY by an unsatisfied external ref: the policy + // flag says blocked, the stored column does not. + decorated := flagsOf(served, flagStdin(served)) + if !decorated["child-x"] || servedRaw["child-x"] || localRaw["child-x"] { + t.Errorf("child-x (externally blocked only): --flags %v, --raw served %v local %v; want true, false, false", + decorated["child-x"], servedRaw["child-x"], localRaw["child-x"]) + } + // Locally blocked rows read the same either way. + for _, title := range []string{"loner", "gate-parent", "gate-kid", "blocker"} { + if decorated[title] != servedRaw[title] { + t.Errorf("%s: --flags %v, --raw %v; a local blocker is the column", title, decorated[title], servedRaw[title]) + } + } + + // A stale flag (set, no blocker) is the column, so both read true. + stale := served.create("stale") + if err := reference.RunEventsMaintenanceTx(context.Background(), func(ctx context.Context, tx issueops.DBTX) error { + _, err := tx.ExecContext(ctx, "UPDATE issues SET is_blocked = 1 WHERE id = ?", stale) + return err + }); err != nil { + t.Fatalf("set the stale flag: %v", err) + } + if got := flagsOf(served, stale+"\n", "--raw"); !got["stale"] { + t.Errorf("--raw for the stale-flagged row = %v, want true", got) + } + if got := flagsOf(served, stale+"\n"); !got["stale"] { + t.Errorf("--flags for the stale-flagged row = %v, want true", got) + } + + // --raw qualifies --flags only. + if r := runBDStdin(t, served, "", "blocked", "--json", "--raw"); r.code != 1 || !strings.Contains(r.stdout+r.stderr, "--raw") { + t.Errorf("bd blocked --raw without --flags: exit %d %s %s, want exit 1 naming --raw", r.code, r.stdout, r.stderr) + } + + // A server that applies the policy answers the decorated flag and the + // wire cannot ask it for the column: --raw is refused there, before + // the annotation read, rather than answered with the policy flag. + proxyAddr, counter := startMaskingProxy(t, addr, func(body map[string]any) { + caps, _ := body["capabilities"].([]any) + body["capabilities"] = append(caps, "policy.external_dependencies") + }) + enforced := newHTTPFixture(t, bin, proxyAddr) + counter.reset() + r := runBDStdin(t, enforced, served.ids["child-x"]+"\n", "blocked", "--flags", "--json", "--raw") + if r.code != 1 || !strings.Contains(r.stdout+r.stderr, "policy.external_dependencies") { + t.Errorf("--raw against a policy server: exit %d %s %s, want exit 1 naming the policy token", r.code, r.stdout, r.stderr) + } + for _, p := range counter.snapshot() { + if strings.Contains(p, "/v0/beads/dependencies/blocking") { + t.Errorf("a refused --raw dialed %s", p) + } + } + }) + + t.Run("older server mask", func(t *testing.T) { + addr := startE2EServer(t) + proxyAddr, counter := startMaskingProxy(t, addr, mcContextMask) + f := newHTTPFixture(t, bin, proxyAddr) + counter.reset() + r := runBDStdin(t, f, "e2e-anything\n", "blocked", "--flags", "--json") + if r.code != 1 { + t.Fatalf("bd blocked --flags against a server without the token exited %d, want 1: %s", r.code, r.stdout) + } + if !strings.Contains(r.stdout+r.stderr, "dependencies.blocking.isBlocked") { + t.Errorf("refusal does not name the missing capability: stdout=%s stderr=%s", r.stdout, r.stderr) + } + for _, p := range counter.snapshot() { + if strings.Contains(p, "/v0/beads/dependencies/blocking") { + t.Errorf("a refused bd blocked --flags dialed %s", p) + } + } + }) +} diff --git a/backend/http/e2e_blocked_test.go b/backend/http/e2e_blocked_test.go new file mode 100644 index 000000000..786379fba --- /dev/null +++ b/backend/http/e2e_blocked_test.go @@ -0,0 +1,229 @@ +//go:build cgo + +package bdhttp_test + +import ( + "encoding/json" + "reflect" + "slices" + "strings" + "testing" +) + +// TestE2E_BlockedOverHTTP runs `bd blocked --json` (the blocked door gc's +// readiness projection reads) through the real `bd` binary against an +// in-process `bd serve`, and against a local embedded workspace holding the +// same graph. +// +// Over HTTP the CLI takes the store's BlockedLister, which dials +// GET /v0/beads/blocked behind blocked.list. The two answers must be the same +// JSON once the values that cannot agree between two workspaces (each row's +// generated id, and its timestamps) are mapped out: the same rows, the same +// members, the same blockers (local, parent-attributed and external), in the +// same order. Against a server that does not advertise blocked.list (an older +// server's handshake) the client refuses before the dial, naming the token. +func TestE2E_BlockedOverHTTP(t *testing.T) { + skipUnlessEmbeddedDolt(t) + bin := buildBD(t) + addr := startE2EServer(t) + + seedBlocked := func(f *remoteRolesFixture) { + f.seed() + // A plain blocks edge, a blocked parent's child attributed to the + // parent, and a labelled blocked row for the filter arms. + blocker := f.create("blocker", "-t", "task", "-p", "1") + gp := f.create("gate-parent", "-t", "epic", "-p", "2") + // Its own priority: rows tied on priority and created_at fall to the + // id order, and ids are generated per workspace, so a tie would order + // the two workspaces differently. + kid := f.create("gate-kid", "-t", "task", "-p", "3") + tagged := f.create("tagged", "-t", "task", "-p", "1", "-l", "lane:a") + // Blocked by nothing but an unsatisfied external ref, as child-x is, + // and labelled: the decorator lists such rows itself, after the label + // query ran, so the filter arms must judge them too. + extTagged := f.create("ext-tagged", "-t", "task", "-p", "4", "-l", "lane:a") + f.mustRun(nil, "dep", "add", kid, gp, "--type", "parent-child") + f.mustRun(nil, "dep", "add", gp, blocker) + f.mustRun(nil, "dep", "add", tagged, blocker) + f.mustRun(nil, "dep", "add", extTagged, "external:other:cap") + } + + local := newEmbeddedFixture(t, bin) + seedBlocked(local) + served := newHTTPFixture(t, bin, addr) + seedBlocked(served) + + for _, args := range [][]string{ + {"blocked", "--json"}, + {"blocked", "--json", "--label", "lane:a"}, + {"blocked", "--json", "--label-any", "lane:a"}, + {"blocked", "--json", "--exclude-label", "lane:a"}, + {"blocked", "--json", "--parent", "{gate-parent}"}, + {"blocked", "--json", "--label", "no-such-label"}, + } { + t.Run(strings.Join(args[1:], " "), func(t *testing.T) { + want := local.mustRun(nil, local.expand(args)...).stdout + got := served.mustRun(nil, served.expand(args)...).stdout + if strings.TrimSpace(want) == "null" || strings.TrimSpace(got) == "null" { + t.Fatalf("bd blocked --json printed null: local=%s served=%s", want, got) + } + if w, g := normalizeBlocked(t, local, want), normalizeBlocked(t, served, got); !reflect.DeepEqual(w, g) { + t.Errorf("served bd blocked --json differs from the local command:\nlocal: %v\nserved: %v", w, g) + } + if w, g := blockedKeyOrder(t, want), blockedKeyOrder(t, got); !reflect.DeepEqual(w, g) { + t.Errorf("served member order %v differs from the local command's %v", g, w) + } + }) + } + + t.Run("names the external blocker", func(t *testing.T) { + got := normalizeBlocked(t, served, served.mustRun(nil, "blocked", "--json").stdout) + found := false + for _, row := range got { + if row["id"] == "child-x" { + found = reflect.DeepEqual(row["blocked_by"], []any{"external:other:cap"}) + } + } + if !found { + t.Errorf("served bd blocked --json does not list child-x blocked by its external ref: %v", got) + } + }) + + // The arms above compare the two answers, which agree just as well when + // both list a row the filter rules out. These pin which rows each filter + // leaves, the external-only ones (child-x unlabelled, ext-tagged + // labelled) among them. + for _, tc := range []struct { + args []string + want []string // the whole listing, when set + listed, ruled []string + }{ + {args: []string{"--label", "lane:a"}, want: []string{"ext-tagged", "tagged"}}, + {args: []string{"--label-any", "lane:a"}, want: []string{"ext-tagged", "tagged"}}, + {args: []string{"--label", "no-such-label"}, want: []string{}}, + {args: []string{"--exclude-label", "lane:a"}, listed: []string{"child-x"}, ruled: []string{"ext-tagged", "tagged"}}, + } { + t.Run("filters external-only rows "+strings.Join(tc.args, " "), func(t *testing.T) { + for _, f := range []struct { + name string + f *remoteRolesFixture + }{{"local", local}, {"served", served}} { + got := f.f.titlesOf(f.f.mustRun(nil, append([]string{"blocked", "--json"}, tc.args...)...).stdout) + if tc.want != nil && !slices.Equal(got, tc.want) { + t.Errorf("%s bd blocked %s listed %v, want %v", f.name, strings.Join(tc.args, " "), got, tc.want) + } + for _, title := range tc.listed { + if !slices.Contains(got, title) { + t.Errorf("%s bd blocked %s does not list %s: %v", f.name, strings.Join(tc.args, " "), title, got) + } + } + for _, title := range tc.ruled { + if slices.Contains(got, title) { + t.Errorf("%s bd blocked %s lists %s, which the filter rules out: %v", f.name, strings.Join(tc.args, " "), title, got) + } + } + } + }) + } + + t.Run("older server mask", func(t *testing.T) { + proxyAddr, counter := startMaskingProxy(t, addr, mcContextMask) + f := newHTTPFixture(t, bin, proxyAddr) + counter.reset() + r := f.run(nil, "blocked", "--json") + if r.code != 1 { + t.Fatalf("bd blocked against a server without blocked.list exited %d, want 1: %s", r.code, r.stdout) + } + if !strings.Contains(r.stdout+r.stderr, "blocked.list") { + t.Errorf("refusal does not name the missing capability: stdout=%s stderr=%s", r.stdout, r.stderr) + } + for _, p := range counter.snapshot() { + if strings.Contains(p, "/v0/beads/blocked") { + t.Errorf("a refused bd blocked dialed %s; the refusal must come before the dial", p) + } + } + }) +} + +// normalizeBlocked parses `bd blocked --json` and maps out what two +// workspaces cannot share: each id (and each blocker id) becomes the title the +// fixture created it under, and every timestamp member is blanked. +func normalizeBlocked(t *testing.T, f *remoteRolesFixture, out string) []map[string]any { + t.Helper() + var rows []map[string]any + if err := json.Unmarshal([]byte(strings.TrimSpace(out)), &rows); err != nil { + t.Fatalf("parse bd blocked --json: %v\n%s", err, out) + } + titleOf := map[string]string{} + for title, id := range f.ids { + titleOf[id] = title + } + var walk func(key string, v any) any + walk = func(key string, v any) any { + switch v := v.(type) { + case map[string]any: + for k, inner := range v { + v[k] = walk(k, inner) + } + return v + case []any: + for i := range v { + v[i] = walk("", v[i]) + } + return v + case string: + if strings.HasSuffix(key, "_at") { + return " " + aliases: ["fart"] + short: "Bond two protos or molecules together" + hidden: false + runnable: true + long: + | Bond two protos or molecules to create a compound. + | + | The bond command is polymorphic - it handles different operand types: + | + | formula + formula → cook both, compound proto + | formula + proto → cook formula, compound proto + | formula + mol → cook formula, spawn and attach + | proto + proto → compound proto (reusable template) + | proto + mol → spawn proto, attach to molecule + | mol + proto → spawn proto, attach to molecule + | mol + mol → join into compound molecule + | + | Formula names (e.g., mol-polecat-arm) are cooked inline as ephemeral protos. + | This avoids needing pre-cooked proto beads in the database. + | + | Bond types: + | sequential (default) - B runs after A completes + | parallel - B runs alongside A + | conditional - B runs only if A fails + | + | With --ref, the spawned proto arm is nested inside the molecule operand + | rather than ordered against it - whichever side of the bond that is - so a + | sequential --ref arm carries no ordering: it is ready as soon as it is + | spawned. Ordering a nested arm against its own container is unsatisfiable + | in both directions (the arm waits for the molecule to close; the molecule + | cannot close while it holds an open arm). --ref is refused with --type + | conditional, which has no safe degradation - omit --ref to bond a + | conditional arm as a sibling. + | + | Phase control: + | By default, spawned protos follow the target's phase: + | - Attaching to mol (Ephemeral=false) → spawns as persistent (Ephemeral=false) + | - Attaching to ephemeral issue (Ephemeral=true) → spawns as ephemeral (Ephemeral=true) + | + | Override with: + | --pour Force spawn as liquid (persistent, Ephemeral=false) + | --ephemeral Force spawn as vapor (ephemeral, Ephemeral=true, excluded from Dolt sync via dolt_ignore) + | + | Dynamic bonding (Christmas Ornament pattern): + | Use --ref to specify a custom child reference with variable substitution. + | This creates IDs like "parent.child-ref" instead of random hashes. + | + | Example: + | bd mol bond mol-worker-arm bd-patrol --ref arm-{{worker_name}} --var worker_name=ace + | # Creates: bd-patrol.arm-ace (and children like bd-patrol.arm-ace.capture) + | + | Use cases: + | - Found important bug during patrol? Use --pour to persist it + | - Need ephemeral diagnostic on persistent feature? Use --ephemeral + | - Spawning per-worker arms on a patrol? Use --ref for readable IDs + | + | Examples: + | bd mol bond mol-feature mol-deploy # Compound proto + | bd mol bond mol-feature mol-deploy --type parallel # Run in parallel + | bd mol bond mol-feature bd-abc123 # Attach proto to molecule + | bd mol bond bd-abc123 bd-def456 # Join two molecules + | bd mol bond mol-critical-bug wisp-patrol --pour # Persist found bug + | bd mol bond mol-temp-check bd-feature --ephemeral # Ephemeral diagnostic + | bd mol bond mol-arm bd-patrol --ref arm-{{name}} --var name=ace # Dynamic child ID + flag --as type=string default="" usage="Custom title for compound proto (proto+proto only)" + flag --dry-run type=bool default="false" usage="Preview what would be created" + flag --ephemeral type=bool default="false" usage="Force spawn as vapor (ephemeral, Ephemeral=true)" + flag --pour type=bool default="false" usage="Force spawn as liquid (persistent, Ephemeral=false)" + flag --ref type=string default="" usage="Custom child reference with {{var}} substitution (e.g., arm-{{polecat_name}})" + flag --type type=string default="sequential" usage="Bond type: sequential, parallel, or conditional" + flag --var type=stringArray default="[]" usage="Variable substitution for spawned protos (key=value)" + +bd mol burn + use: "burn [molecule-id...]" + short: "Delete a molecule without creating a digest" + hidden: false + runnable: true + long: + | Burn a molecule, deleting it without creating a digest. + | + | Unlike squash (which creates a permanent digest before deletion), burn + | completely removes the molecule with no trace. Use this for: + | - Abandoned patrol cycles + | - Crashed or failed workflows + | - Test/debug molecules you don't want to preserve + | + | The burn operation differs based on molecule phase: + | - Wisp (ephemeral): Direct delete + | - Mol (persistent): Cascade delete (syncs to remotes) + | + | CAUTION: This is a destructive operation. The molecule's data will be + | permanently lost. If you want to preserve a summary, use 'bd mol squash'. + | + | Example: + | bd mol burn bd-abc123 # Delete molecule with no trace + | bd mol burn bd-abc123 --dry-run # Preview what would be deleted + | bd mol burn bd-abc123 --force # Skip confirmation + | bd mol burn bd-a1 bd-b2 bd-c3 # Batch delete multiple wisps + flag --dry-run type=bool default="false" usage="Preview what would be deleted" + flag --force type=bool default="false" usage="Skip confirmation prompt" + flag --yes -y type=bool default="false" hidden usage="Alias for --force (skip confirmation)" + +bd mol current + use: "current [molecule-id]" + short: "Show current position in molecule workflow" + hidden: false + runnable: true + long: + | Show where you are in a molecule workflow. + | + | If molecule-id is given, show status for that molecule. + | If not given, infer from in_progress issues assigned to current agent. + | + | The output shows all steps with status indicators: + | [done] - Step is complete (closed) + | [current] - Step is in_progress (you are here) + | [ready] - Step is ready to start (unblocked) + | [blocked] - Step is blocked by dependencies + | [pending] - Step is waiting + | + | For large molecules (>100 steps), a summary is shown instead. + | Use --limit or --range to view specific steps: + | bd mol current --limit 50 # Show first 50 steps + | bd mol current --range 100-150 # Show steps 100-150 + flag --for type=string default="" usage="Show molecules for a specific agent/assignee" + flag --limit type=int default="0" usage="Maximum number of steps to display (0 = auto, use 'all' threshold)" + flag --range type=string default="" usage="Display specific step range (e.g., '1-50', '100-150')" + +bd mol distill + use: "distill [formula-name]" + short: "Extract a formula from an existing epic" + hidden: false + runnable: true + long: + | Distill a molecule by extracting a reusable formula from an existing epic. + | + | This is the reverse of pour: instead of formula → molecule, it's molecule → formula. + | + | The distill command: + | 1. Loads the existing epic and all its children + | 2. Converts the structure to a .formula.json file + | 3. Replaces concrete values with {{variable}} placeholders (via --var flags) + | + | Use cases: + | - Team develops good workflow organically, wants to reuse it + | - Capture tribal knowledge as executable templates + | - Create starting point for similar future work + | + | Variable syntax (both work - we detect which side is the concrete value): + | --var branch=feature-auth Spawn-style: variable=value (recommended) + | --var feature-auth=branch Substitution-style: value=variable + | + | Output locations (first writable wins): + | 1. /formulas/ (project-level, default) + | 2. /.beads/formulas/ (repo-local formulas) + | 3. ~/.beads/formulas/ (user-level, if project not writable) + | + | Examples: + | bd mol distill bd-o5xe my-workflow + | bd mol distill bd-abc release-workflow --var feature_name=auth-refactor + flag --dry-run type=bool default="false" usage="Preview what would be created" + flag --output type=string default="" usage="Output directory for formula file" + flag --var type=stringArray default="[]" usage="Replace value with {{variable}} placeholder (variable=value)" + +bd mol last-activity + use: "last-activity " + short: "Show last activity timestamp for a molecule" + hidden: false + runnable: true + long: + | Show the most recent activity timestamp for a molecule. + | + | Returns the timestamp of the most recent change to any step in the molecule, + | making it easy to detect stale or stuck molecules. + | + | Activity sources: + | step_closed - A step was closed + | step_updated - A step was updated (claimed, edited, etc.) + | molecule_updated - The molecule root itself was updated + | + | Examples: + | bd mol last-activity hq-wisp-0laki + | bd mol last-activity hq-wisp-0laki --json + +bd mol pour + use: "pour " + short: "Instantiate a proto as a persistent mol (solid -> liquid)" + hidden: false + runnable: true + long: + | Pour a proto into a persistent mol - like pouring molten metal into a mold. + | + | This is the chemistry-inspired command for creating PERSISTENT work from templates. + | The resulting mol is stored as persistent beads in the issue database and + | syncs like any other bead (bd dolt push / pull). + | + | Phase transition: Proto (solid) -> pour -> Mol (liquid) + | + | WHEN TO USE POUR vs WISP: + | pour (liquid): Persistent work that needs audit trail + | - Feature implementations spanning multiple sessions + | - Work you may need to reference later + | - Anything worth preserving in git history + | + | wisp (vapor): Ephemeral work that auto-cleans up + | - Release workflows (one-time execution) + | - Operational loops and recurring cycles + | - Health checks and diagnostics + | - Any operational workflow without audit value + | + | TIP: Formulas can specify phase:"vapor" to recommend wisp usage. + | If you pour a vapor-phase formula, you'll get a warning. + | + | Examples: + | bd mol pour mol-feature --var name=auth # Persistent feature work + | bd mol pour mol-review --var pr=123 # Persistent code review + flag --assignee type=string default="" usage="Assign the root issue to this agent/user" + flag --attach type=stringSlice default="[]" usage="Proto to attach after spawning (repeatable)" + flag --attach-type type=string default="sequential" usage="Bond type for attachments: sequential, parallel, or conditional" + flag --dry-run type=bool default="false" usage="Preview what would be created" + flag --var type=stringArray default="[]" usage="Variable substitution (key=value); a name the proto cannot consume is an error" + +bd mol progress + use: "progress [molecule-id]" + short: "Show molecule progress summary" + hidden: false + runnable: true + long: + | Show efficient progress summary for a molecule. + | + | This command uses indexed queries to count progress without loading all steps, + | making it suitable for very large molecules (millions of steps). + | + | If no molecule-id is given, shows progress for any molecule you're working on. + | + | Output includes: + | - Progress: completed / total (percentage) + | - Current step: the in-progress step (if any) + | - Rate: steps/hour based on closure times + | - ETA: estimated time to completion + | + | Example: + | bd mol progress bd-hanoi-xyz + +bd mol ready + use: "ready --gated" + short: "Find molecules ready for gate-resume dispatch" + hidden: false + runnable: true + long: + | Find molecules where a gate has closed and the workflow is ready to resume. + | + | This command discovers molecules waiting at a gate step where: + | 1. The molecule has a gate bead that blocks a step + | 2. The gate bead is now closed (condition satisfied) + | 3. The blocked step is now ready to proceed + | 4. No agent currently has this molecule hooked + | + | This enables discovery-based resume without explicit waiter tracking. + | The patrol system uses this to find and dispatch gate-ready molecules. + | + | Examples: + | bd mol ready --gated # Find all gate-ready molecules + | bd mol ready --gated --json # JSON output for automation + flag --gated type=bool default="false" usage="Find molecules ready for gate-resume dispatch (always on for this subcommand)" + +bd mol seed + use: "seed " + short: "Verify formula accessibility" + hidden: false + runnable: true + long: + | Verify that a formula is accessible and can be cooked. + | + | The seed command checks formula search paths to ensure a formula exists + | and can be loaded. This is useful for verifying system health before + | attempting to spawn work from a formula. + | + | Formula search paths (checked in order): + | 1. /formulas/ (active project) + | 2. /.beads/formulas/ (repo-local formulas) + | 3. ~/.beads/formulas/ (user level) + | 4. $GT_ROOT/.beads/formulas/ (shared workspace root, if GT_ROOT set) + | + | Examples: + | bd mol seed mol-feature # Verify specific formula + | bd mol seed mol-review --var name=test # Verify with variable substitution + flag --var type=stringArray default="[]" usage="Variable substitution for condition filtering (key=value)" + +bd mol show + use: "show " + short: "Show molecule details" + hidden: false + runnable: true + long: + | Show molecule structure and details. + | + | A molecule's steps are the issues linked to its root by parent-child + | dependencies (bd create --parent, bd mol pour); an id that merely looks + | hierarchical, like bd-xyz.4, does not make an issue a step. + | + | The --parallel flag highlights parallelizable steps: + | - Steps with no blocking dependencies can run in parallel + | - Shows which steps are ready to start now + | - Identifies parallel groups (steps that can run concurrently) + | + | Example: + | bd mol show bd-patrol --parallel + flag --parallel -p type=bool default="false" usage="Show parallel step analysis" + +bd mol squash + use: "squash " + short: "Compress molecule execution into a digest" + hidden: false + runnable: true + long: + | Squash a molecule's ephemeral children into a single digest issue. + | + | This command collects all ephemeral child issues of a molecule (Ephemeral=true), + | generates a summary digest, and promotes the wisps to persistent by + | clearing their Wisp flag (or optionally deletes them). + | + | The squash operation: + | 1. Loads the molecule and all its children + | 2. Filters to only wisps (ephemeral issues with Ephemeral=true) + | 3. Generates a digest (summary of work done) + | 4. Creates a permanent digest issue (Ephemeral=false) + | 5. Clears Wisp flag on children (promotes to persistent) + | OR keeps them with --keep-children (default: delete) + | + | AGENT INTEGRATION: + | Use --summary to provide an AI-generated summary. This keeps bd as a pure + | tool - the calling agent (orchestrator worker, Claude Code, etc.) is responsible + | for generating intelligent summaries. Without --summary, a basic concatenation + | of child issue content is used. + | + | This is part of the wisp workflow: spawn creates wisps, + | execution happens, squash compresses the trace into an outcome (digest). + | + | Example: + | bd mol squash bd-abc123 # Squash and promote children + | bd mol squash bd-abc123 --dry-run # Preview what would be squashed + | bd mol squash bd-abc123 --keep-children # Keep wisps after digest + | bd mol squash bd-abc123 --summary "Agent-generated summary of work done" + flag --dry-run type=bool default="false" usage="Preview what would be squashed" + flag --keep-children type=bool default="false" usage="Don't delete ephemeral children after squash" + flag --summary type=string default="" usage="Agent-provided summary (bypasses auto-generation)" + +bd mol stale + use: "stale" + short: "Detect molecules with all children closed but root still open" + hidden: false + runnable: true + long: + | Detect molecules (epics with children) whose children are all closed + | with completing reasons, but the root is still open. + | + | A molecule is considered stale if: + | 1. Every child is closed with a completing reason (not duplicate/wontfix/superseded) + | 2. Root issue is still open + | 3. Not assigned to anyone (optional, use --unassigned) + | 4. Is blocking other work (optional, use --blocking) + | + | Review whether epic scope is actually finished before closing — child + | closure alone does not prove the epic's stated work is done (GH#5026). + | + | Examples: + | bd mol stale # List all stale molecules + | bd mol stale --json # Machine-readable output + | bd mol stale --blocking # Only show those blocking other work + | bd mol stale --unassigned # Only show unassigned molecules + | bd mol stale --all # Include molecules with 0 children + flag --all type=bool default="false" usage="Include molecules with 0 children" + flag --blocking type=bool default="false" usage="Only show molecules blocking other work" + flag --unassigned type=bool default="false" usage="Only show unassigned molecules" + +bd mol wisp + use: "wisp [proto-id]" + short: "Create or manage wisps (ephemeral molecules)" + hidden: false + runnable: true + long: + | Create or manage wisps - EPHEMERAL molecules for operational workflows. + | + | When called with a proto-id argument, creates a wisp from that proto. + | When called with a subcommand (list, gc), manages existing wisps. + | + | Wisps are issues with Ephemeral=true in the main database. They're stored + | locally but NOT synced via git. + | + | WHEN TO USE WISP vs POUR: + | wisp (vapor): Ephemeral work that auto-cleans up + | - Release workflows (one-time execution) + | - Operational loops and recurring cycles + | - Health checks and diagnostics + | - Any operational workflow without audit value + | + | pour (liquid): Persistent work that needs audit trail + | - Feature implementations spanning multiple sessions + | - Work you may need to reference later + | - Anything worth preserving in git history + | + | TIP: Formulas can specify phase:"vapor" to recommend wisp usage. + | If you use pour on a vapor-phase formula, you'll get a warning. + | + | The wisp lifecycle: + | 1. Create: bd mol wisp or bd create --ephemeral + | 2. Execute: Normal bd operations work on wisp issues + | 3. Squash: bd mol squash (clears Ephemeral flag, promotes to persistent) + | 4. Or burn: bd mol burn (deletes without creating digest) + | + | Examples: + | bd mol wisp beads-release --var version=1.0 # Release workflow + | bd mol wisp mol-my-workflow # Ephemeral operational cycle + | bd mol wisp list # List all wisps + | bd mol wisp gc # Garbage collect old wisps + | + | Subcommands: + | list List all wisps in current context + | gc Garbage collect orphaned wisps + flag --dry-run type=bool default="false" usage="Preview what would be created" + flag --root-only type=bool default="false" usage="Create only the root issue (no child step issues)" + flag --var type=stringArray default="[]" usage="Variable substitution (key=value); a name the proto cannot consume is an error" + +bd mol wisp create + use: "create " + short: "Instantiate a proto as a wisp (solid -> vapor)" + hidden: false + runnable: true + long: + | Create a wisp from a proto - sublimation from solid to vapor. + | + | This is the chemistry-inspired command for creating ephemeral work from templates. + | The resulting wisp is stored in the main database with Ephemeral=true and NOT synced via git. + | + | Phase transition: Proto (solid) -> Wisp (vapor) + | + | Use wisp for: + | - Operational loops and recurring cycles + | - Health checks and monitoring + | - One-shot orchestration runs + | - Routine operations with no audit value + | + | The wisp will: + | - Be stored in main database with Ephemeral=true flag + | - NOT be synced via git + | - Either evaporate (burn) or condense to digest (squash) + | + | Examples: + | bd mol wisp create mol-patrol # Ephemeral patrol cycle + | bd mol wisp create mol-health-check # One-time health check + | bd mol wisp create mol-diagnostics --var target=db # Diagnostic run + flag --dry-run type=bool default="false" usage="Preview what would be created" + flag --root-only type=bool default="false" usage="Create only the root issue (no child step issues)" + flag --var type=stringArray default="[]" usage="Variable substitution (key=value); a name the proto cannot consume is an error" + +bd mol wisp gc + use: "gc" + short: "Garbage collect old/abandoned wisps" + hidden: false + runnable: true + long: + | Garbage collect old or abandoned wisps from the database. + | + | A wisp is considered abandoned if: + | - It hasn't been updated in --age duration and is not closed + | - AND it is not live work: blocked steps (waiting on a dependency), pinned + | beads, and any step whose status category is wip (in_progress, blocked, + | hooked) or frozen (deferred, pinned) are never reclaimed by age, no matter + | how long they have been waiting (GH#4394). Custom statuses count by their + | configured category, so only plain open (active) and closed (done) steps + | are age-reclaimable. If the blocked set or the custom-status list cannot be + | read, the GC aborts rather than risk reclaiming live steps. + | + | Wisps that depend on an abandoned wisp are deleted with it, closed ones + | included even without --all, but only if they too haven't been updated in + | --age duration and are not live work. A dependent that is too young is + | spared and loses its edge to the deleted wisp: an open one is collected once + | it ages out, a closed one only by --all, --closed or 'bd purge'. + | + | Abandoned wisps are deleted without creating a digest. Use 'bd mol squash' + | if you want to preserve a summary before garbage collection. + | + | Use --closed to purge ALL closed wisps (regardless of age). This is the + | fastest way to reclaim space from accumulated wisp bloat. Safe by default: + | requires --force to actually delete. + | + | Note: This uses time-based cleanup, appropriate for ephemeral wisps. + | For graph-pressure staleness detection (blocking other work), see 'bd mol stale'. + | + | Examples: + | bd mol wisp gc # Clean abandoned wisps (default: 1h threshold) + | bd mol wisp gc --dry-run # Preview what would be cleaned + | bd mol wisp gc --age 24h # Custom age threshold + | bd mol wisp gc --all # Also clean closed wisps older than threshold + | bd mol wisp gc --closed # Preview closed wisp deletion + | bd mol wisp gc --closed --force # Delete all closed wisps + | bd mol wisp gc --closed --dry-run # Explicit dry-run (same as no --force) + | bd mol wisp gc --exclude-type agent,rig # Protect agent and rig wisps from GC + | bd mol wisp gc --closed --force --exclude-type mol # Delete closed wisps except mol type + flag --age type=string default="1h" usage="Age threshold for abandoned wisp detection" + flag --all type=bool default="false" usage="Also clean closed wisps older than threshold" + flag --closed type=bool default="false" usage="Delete all closed wisps (ignores --age threshold)" + flag --dry-run type=bool default="false" usage="Preview what would be cleaned" + flag --exclude-type type=stringSlice default="[]" usage="Exclude wisps of these types from GC (comma-separated, e.g., agent,rig)" + flag --force -f type=bool default="false" usage="Actually delete (default: preview only)" + +bd mol wisp list + use: "list" + short: "List all wisps in current context" + hidden: false + runnable: true + long: + | List all wisps (ephemeral molecules) in the current context. + | + | Wisps are issues with Ephemeral=true in the main database. They are stored + | locally but not synced via git. + | + | The list shows: + | - ID: Issue ID of the wisp + | - Title: Wisp title + | - Status: Current status (open, in_progress, closed) + | - Started: When the wisp was created + | - Updated: Last modification time + | + | Old wisp detection: + | - Old wisps haven't been updated in 24+ hours + | - Use 'bd mol wisp gc' to clean up old/abandoned wisps + | + | Examples: + | bd mol wisp list # List all wisps + | bd mol wisp list --json # JSON output for programmatic use + | bd mol wisp list --all # Include closed wisps + flag --all type=bool default="false" usage="Include closed wisps" + flag --type type=string default="" usage="Filter by issue type (e.g., agent, task, patrol)" + +bd note + use: "note [text...]" + short: "Append a note to an issue" + group: "issues" + hidden: false + runnable: true + long: + | Append a note to an issue's notes field. + | + | Shorthand for 'bd update --append-notes "text"'. + | + | Examples: + | bd note gt-abc "Fixed the flaky test" + | bd note gt-abc Fixed the flaky test + | echo "note from pipe" | bd note gt-abc --stdin + | bd note gt-abc --file notes.txt + | + | Note: "note" has NO subcommands — it only appends. + | To read notes on an issue, use: bd show + flag --file type=string default="" annotations={cobra_annotation_mutually_exclusive=["stdin file"]} usage="Read note text from file" + flag --stdin type=bool default="false" annotations={cobra_annotation_mutually_exclusive=["stdin file"]} usage="Read note text from stdin" + +bd notion + use: "notion" + short: "Notion integration commands" + hidden: false + runnable: false + long: + | Commands for syncing issues between beads and Notion. + +bd notion connect + use: "connect" + short: "Connect bd to an existing Notion database or data source" + hidden: false + runnable: true + flag --url type=string default="" annotations={cobra_annotation_bash_completion_one_required_flag=["true"]} usage="Existing Notion database or data source URL" + +bd notion init + use: "init" + short: "Create a dedicated Beads database in Notion" + hidden: false + runnable: true + flag --parent type=string default="" annotations={cobra_annotation_bash_completion_one_required_flag=["true"]} usage="Parent page ID" + flag --title type=string default="Beads Issues" usage="Database title" + +bd notion pull + use: "pull [refs...]" + short: "Pull specific items from Notion" + hidden: false + runnable: true + long: + | Pull one or more items from Notion. + | + | Accepts bead IDs or external references as positional arguments. + | Equivalent to: bd notion sync --pull --issues + flag --dry-run type=bool default="false" usage="Preview pull without making changes" + +bd notion push + use: "push [bead-ids...]" + short: "Push specific beads to Notion" + hidden: false + runnable: true + long: + | Push one or more beads issues to Notion. + | + | Accepts bead IDs as positional arguments. + | Equivalent to: bd notion sync --push --issues + flag --dry-run type=bool default="false" usage="Preview push without making changes" + +bd notion status + use: "status" + short: "Show Notion sync status" + hidden: false + runnable: true + +bd notion sync + use: "sync" + short: "Sync issues with Notion" + hidden: false + runnable: true + long: + | Synchronize issues between beads and Notion. + | + | By default this performs bidirectional sync. Use --pull or --push to limit direction. + flag --create-only type=bool default="false" usage="Only create missing remote pages, do not update existing ones" + flag --dry-run type=bool default="false" usage="Preview changes without making mutations" + flag --issues type=string default="" usage="Comma-separated bead IDs to sync selectively (e.g., bd-abc,bd-def). Mutually exclusive with --parent." + flag --parent type=string default="" usage="Limit push to this bead and its descendants (push only). Mutually exclusive with --issues." + flag --prefer-local type=bool default="false" usage="On conflict, keep the local beads version" + flag --prefer-notion type=bool default="false" usage="On conflict, use the Notion version" + flag --pull type=bool default="false" usage="Only pull issues from Notion" + flag --push type=bool default="false" usage="Only push issues to Notion" + flag --state type=string default="all" usage="Issue state to sync: open, closed, or all" + +bd onboard + use: "onboard" + short: "Display minimal snippet for agent instructions file" + group: "setup" + hidden: false + runnable: true + long: + | Display a minimal snippet to add to your agent instructions file for bd integration. + | + | By default, the agent instructions file is AGENTS.md. Use 'bd init --agents-file' + | to configure a different filename (e.g. BEADS.md). + | + | This outputs a small (~10 line) snippet that points to 'bd prime' for full + | workflow context. This is the same minimal profile that 'bd init' generates + | by default. This approach: + | + | • Keeps your agent file lean (doesn't bloat with instructions) + | • bd prime provides dynamic, always-current workflow details + | • Hooks auto-inject bd prime at session start + | + | For agents or environments that do not auto-inject hook output, use + | 'bd init --agents-profile=full' to embed the complete command reference. + +bd orphans + use: "orphans" + short: "Identify orphaned issues (referenced in commits but still open)" + hidden: false + runnable: true + long: + | Identify orphaned issues - issues that are referenced in commit messages but remain open or in_progress in the database. + | + | This helps identify work that has been implemented but not formally closed. + | + | Examples: + | bd orphans # Show orphaned issues + | bd orphans --json # Machine-readable output + | bd orphans --details # Show full commit information + | bd orphans --fix # Close orphaned issues with confirmation + | bd orphans --label theme:personal # Only orphans with this label + | bd orphans --label-any theme:personal,theme:ventures # Orphans with either label + flag --details type=bool default="false" usage="Show full commit information" + flag --fix -f type=bool default="false" usage="Close orphaned issues with confirmation" + flag --label -l type=stringSlice default="[]" usage="Filter by labels (AND: must have ALL). Can combine with --label-any" + flag --label-any type=stringSlice default="[]" usage="Filter by labels (OR: must have AT LEAST ONE). Can combine with --label" + +bd ping + use: "ping" + short: "Check database connectivity" + group: "maint" + hidden: false + runnable: true + long: + | Lightweight health check that confirms bd can reach its database. + | + | Steps: + | 1. Resolve the .beads workspace + | 2. Open the store (embedded or server) + | 3. Run a trivial query (one issue row; a remote backend reads its + | authenticated server context instead) + | 4. Report timing + | + | Exit 0 on success, exit 1 on failure. + | + | Examples: + | bd ping # Quick connectivity check + | bd ping --json # Structured output for automation + +bd preflight + use: "preflight" + short: "Show PR readiness checklist" + group: "maint" + hidden: false + runnable: true + long: + | Display a checklist of common pre-PR checks for contributors. + | + | This command helps catch common issues before pushing to CI: + | - Tests not run locally + | - Lint errors + | - Unformatted Go files + | - .beads/issues.jsonl pollution + | - Stale nix vendorHash + | - Version mismatches + | + | Examples: + | bd preflight # Show checklist + | bd preflight --check # Run checks automatically + | bd preflight --check --json # JSON output for programmatic use + | bd preflight --check --skip-lint # Explicitly skip lint check + | + flag --check type=bool default="false" usage="Run checks automatically" + flag --fix type=bool default="false" usage="Auto-fix issues where possible (vendorHash)" + flag --skip-lint type=bool default="false" usage="Skip lint check explicitly" + +bd prime + use: "prime" + short: "Output AI-optimized workflow context" + group: "setup" + hidden: false + runnable: true + long: + | Output essential Beads workflow context in AI-optimized markdown format. + | + | Automatically detects if MCP server is active and adapts output: + | - MCP mode: Brief workflow reminders (~50 tokens) + | - CLI mode: Full command reference (~1-2k tokens) + | + | Designed for Claude Code, Gemini CLI, and Codex SessionStart hooks to prevent + | agents from forgetting bd workflow after context compaction. + | + | Config options: + | - no-git-ops: When true, outputs stealth mode (no git commands in session close protocol). + | Set via: bd config set no-git-ops true + | Useful when you want to control when commits happen manually. + | - agent.profile: Explicit policy profile for git/commit authority wording + | (conservative | minimal | team-maintainer; default conservative). + | Set via: bd config set agent.profile team-maintainer + | Or per-session: BD_AGENT_PROFILE=team-maintainer (env var takes precedence). + | See docs/getting-started/ide-setup.md#policy-profiles for what each profile means. + | - prime.disabled: When true, bd prime prints nothing, as it does outside a + | workspace (an empty envelope under --hook-json), whatever its other flags. + | For sessions whose host briefs the agent itself but that inherit a + | project's bd prime hook, such as an orchestrator's agent sessions. + | Set per-session: BD_PRIME_DISABLED=true. Or: bd config set prime.disabled true + | + | Workflow customization: + | - Place a PRIME.md file to override the default workflow text. Checked in this + | order, once bd resolves a workspace (outside one, prime emits no content): + | (1) .beads/PRIME.md relative to the current directory (the -C target + | when -C is set); + | (2) PRIME.md in the .beads directory bd resolves for this workspace + | (honors $BEADS_DIR, which -C overrides; a redirected .beads is + | followed); + | (3) the global PRIME.md in bd's user config dir: + | ~/.config/beads/ on Linux ($XDG_CONFIG_HOME/beads/ if set), + | ~/Library/Application Support/beads/ on macOS, + | %AppData%\beads\ on Windows. + | - Persistent memories (from bd remember) are still appended so memory + | injection keeps working under a custom template. + | - Use --export to dump the default content for customization. + | - Use --memories-only for hook contexts that should inject only persistent memories; this returns only the memories section even when a custom PRIME.md is present. + | - Use --no-memories to omit the persistent memories section (useful when the memories section is large and would dominate a context budget). --memories-only takes precedence if both are set. + | + | Memory injection caps: + | Large memory sets can exceed what a session-start hook host will ingest, + | and hosts truncate silently. Cap what prime injects with --max-memories N + | and/or --max-memory-chars N (or the prime.max-memories / + | prime.max-memory-chars config keys; an explicit flag wins, and an explicit + | 0 forces unlimited). Caps apply at whole-memory boundaries, at least one + | memory is always emitted, and a banner ahead of the entries reports how + | many were elided and how to browse the rest with bd memories. + | --max-memory-chars caps the total bytes of the injected memory entries; + | the section header and elision banner are excluded from the budget. + flag --export type=bool default="false" usage="Output default content (ignores PRIME.md override)" + flag --full type=bool default="false" usage="Force full CLI output (ignore MCP detection)" + flag --hook-json type=bool default="false" usage="Wrap output in the SessionStart hook JSON envelope (Claude Code, Gemini CLI, Codex)" + flag --max-memories type=int default="0" usage="Cap injected persistent memories to N entries (0 = unlimited; falls back to the prime.max-memories config key)" + flag --max-memory-chars type=int default="0" usage="Cap the total bytes of injected memory entries, at whole-memory boundaries; section header and banner are not counted (0 = unlimited; falls back to the prime.max-memory-chars config key)" + flag --mcp type=bool default="false" usage="Force MCP mode (minimal output)" + flag --memories-only type=bool default="false" usage="Output only persistent memories for compact hook contexts" + flag --no-memories type=bool default="false" usage="Omit the persistent memories section (ignored when --memories-only is set, which wins)" + flag --stealth type=bool default="false" usage="Stealth mode (no git operations, flush only)" + +bd priority + use: "priority " + short: "Set the priority of an issue" + group: "issues" + hidden: false + runnable: true + long: + | Set the priority of an issue. + | + | Shorthand for 'bd update --priority '. + | + | Priority levels: + | 0 - Critical (security, data loss, broken builds) + | 1 - High (major features, important bugs) + | 2 - Medium (default) + | 3 - Low (polish, optimization) + | 4 - Backlog (future ideas) + | + | Examples: + | bd priority bd-123 0 # Critical + | bd priority bd-123 2 # Medium + +bd promote + use: "promote " + short: "Promote a wisp to a permanent bead" + group: "issues" + hidden: false + runnable: true + long: + | Promote a wisp (ephemeral issue) to a permanent bead. + | + | This copies the issue from the wisps table (dolt_ignored) to the permanent + | issues table (Dolt-versioned), preserving labels, dependencies, events, and + | comments. The original ID is preserved so all links keep working. + | + | A comment is added recording the promotion and optional reason. + | + | Examples: + | bd promote bd-wisp-abc123 + | bd promote bd-wisp-abc123 --reason "Worth tracking long-term" + flag --reason -r type=string default="" usage="Reason for promotion" + +bd provenance + use: "provenance" + short: "Append-only provenance event log" + group: "issues" + hidden: false + runnable: false + long: + | Record and read provenance events: typed bindings from an issue to an + | opaque external artifact (a git SHA, PR, work-id, transcript, or branch). + | + | The log is append-only — there is no update or delete. bd never interprets the + | actor or ref; only kind and ref-kind are structurally validated. Recording is + | idempotent on a deterministic id, so a producer firing twice is harmless. + +bd provenance by-ref + use: "by-ref " + short: "List provenance events bound to a ref" + hidden: false + runnable: true + +bd provenance log + use: "log " + short: "List provenance events for an issue" + hidden: false + runnable: true + flag --kind type=string default="" usage="filter by kind (optional)" + +bd provenance record + use: "record --issue --kind --source " + short: "Record a provenance event (idempotent)" + hidden: false + runnable: true + long: + | Record a provenance event. The event is appended idempotently: a + | deterministic id is computed from source:issue:kind:(ref or --at), so re-running + | the same record is a no-op. + | + | An event recorded without --ref requires --at so the id is caller-owned. + flag --actor type=string default="" usage="opaque actor identifier (optional)" + flag --at type=string default="" usage="event-time as RFC3339 (required for ref-less kinds)" + flag --issue type=string default="" annotations={cobra_annotation_bash_completion_one_required_flag=["true"]} usage="issue id (required)" + flag --kind type=string default="" annotations={cobra_annotation_bash_completion_one_required_flag=["true"]} usage="event kind: cut|claim|suspend|resume|handoff|commit|land|used (required)" + flag --payload type=string default="" usage="opaque payload, e.g. JSON (optional)" + flag --ref type=string default="" usage="opaque external reference, e.g. a SHA or PR url (optional)" + flag --ref-kind type=string default="" usage="ref kind: git-sha|pr|work-id|transcript|branch (optional)" + flag --source type=string default="" annotations={cobra_annotation_bash_completion_one_required_flag=["true"]} usage="producer of the event, e.g. git-hook, orchestrator (required)" + +bd prune + use: "prune" + short: "Delete old closed beads to reclaim space and shrink exports" + group: "maint" + hidden: false + runnable: true + long: + | Permanently delete closed non-ephemeral beads and their associated data. + | + | Use this to trim closed regular beads (tasks, features, bugs, chores, etc.) + | that are no longer useful. The common case is a long-lived repo where + | closed work has piled up and is bloating auto-export or slowing queries. + | + | Requires --older-than or --pattern. The flag is a safety gate — without + | it, a muscle-memory `--force` could wipe every closed bead in the repo. + | Use `--pattern '*'` if you really do want to sweep everything closed. + | + | Deletes: issues, dependencies, labels, events, and comments for matching beads. + | Skips: pinned beads (protected), open/in-progress beads, and ephemeral beads. + | + | Also skips closed beads whose ID appears in the description, notes, or + | comments of any open / in-progress bead. This protects ADR / decision / + | verification trails that downstream beads still cite. Use + | --ignore-references to override (e.g., when bulk-decommissioning a + | retired label across the rig). + | + | To delete closed ephemeral beads (wisps, transient molecules) use + | `bd purge` instead. + | + | For full Dolt storage reclaim after deleting many rows, follow with `bd flatten` + | so history can be collapsed and old chunks can be garbage-collected. + | + | EXAMPLES: + | bd prune --older-than 30d # Preview closed beads >30d old + | bd prune --older-than 30d --force # Delete them + | bd prune --older-than 90d --dry-run # Detailed preview with stats + | bd prune --pattern "*" --force # Delete all closed regular beads + | bd prune --pattern "gm-temp-*" --force # Scope to a pattern + flag --dry-run type=bool default="false" usage="Preview what would be pruned with stats" + flag --force -f type=bool default="false" usage="Actually prune (without this, shows preview)" + flag --ignore-references type=bool default="false" usage="Delete closed beads even when referenced by open beads (use with care; see --help for details)" + flag --older-than type=string default="" usage="Only prune beads closed more than N ago (e.g., 30d, 2w, 60, 36h)" + flag --pattern type=string default="" usage="Only prune beads matching ID glob pattern (e.g., 'gm-old-*')" + +bd purge + use: "purge" + short: "Delete closed ephemeral beads to reclaim space" + group: "maint" + hidden: false + runnable: true + long: + | Permanently delete closed ephemeral beads and their associated data. + | + | Closed ephemeral beads (wisps, transient molecules) accumulate rapidly and + | have no value once closed. This command removes them to reclaim storage. + | + | Deletes: issues, dependencies, labels, events, and comments for matching beads. + | Skips: pinned beads, and closed beads a live bead still depends on through a + | parent-child, tracks or blocks edge (a closed molecule root whose step is open, + | a closed bead a live convoy tracks). Live means any status that is not done. + | + | --wisps-plane selects by storage plane instead: every closed row stored in the + | wisps table, including --no-history beads, which the default ephemeral + | selection leaves to `bd prune`. It reaches durable-tier rows, so it requires + | --older-than or --pattern, like `bd prune`. + | + | --limit N caps one run at N beads, oldest-closed first, so a large backlog can + | be drained in bounded transactions; --json then reports "remaining" and + | "has_more". Loop while has_more is true. + | + | --older-than takes days (7, 7d), weeks (2w) or a duration with hour precision + | (36h, 168h, 90m). + | + | To delete closed non-ephemeral beads (regular tasks, features, bugs, etc.) + | use `bd prune` instead. + | + | For full Dolt storage reclaim after deleting many rows, follow with `bd flatten` + | so history can be collapsed and old chunks can be garbage-collected. + | + | EXAMPLES: + | bd purge # Preview what would be purged + | bd purge --force # Delete all closed ephemeral beads + | bd purge --older-than 7d --force # Only purge items closed 7+ days ago + | bd purge --pattern "*-wisp-*" # Only purge matching ID pattern + | bd purge --older-than 36h --force # Hour precision: closed 36+ hours ago + | bd purge --wisps-plane --older-than 168h --force + | # Every closed wisps-table row, incl. no-history + | bd purge --dry-run # Detailed preview with stats + flag --dry-run type=bool default="false" usage="Preview what would be purged with stats" + flag --force -f type=bool default="false" usage="Actually purge (without this, shows preview)" + flag --limit type=int default="0" usage="Purge at most N beads this run, oldest-closed first (0 = no limit); --json reports remaining/has_more" + flag --older-than type=string default="" usage="Only purge beads closed more than N ago (e.g., 7d, 2w, 30, 36h)" + flag --pattern type=string default="" usage="Only purge beads matching ID glob pattern (e.g., *-wisp-*)" + flag --wisps-plane type=bool default="false" usage="Select every closed row in the wisps table, including --no-history beads (requires --older-than or --pattern)" + +bd q + use: "q [title]" + short: "Quick capture: create issue and output only ID" + group: "issues" + hidden: false + runnable: true + long: + | Quick capture creates an issue and outputs only the issue ID. + | Designed for scripting and AI agent integration. + | + | Example: + | bd q "Fix login bug" # Outputs: bd-a1b2 + | ISSUE=$(bd q "New feature") # Capture ID in variable + | bd q "Task" | xargs bd show # Pipe to other commands + | bd q "Subtask" --parent=bd-a1b2 # Hierarchical child (outputs: bd-a1b2.1) + flag --labels -l type=stringSlice default="[]" usage="Labels" + flag --parent type=string default="" usage="Parent issue ID for hierarchical child (e.g., 'bd-a3f8e9')" + flag --priority -p type=string default="2" usage="Priority (0-4 or P0-P4)" + flag --type -t type=string default="task" usage="Issue type" + +bd query + use: "query [expression]" + short: "Query issues using a simple query language" + group: "issues" + hidden: false + runnable: true + long: + | Query issues using a simple query language that supports compound filters, + | boolean operators, and date-relative expressions. + | + | The query language enables complex filtering that would otherwise require + | multiple flags or piping through jq. + | + | Syntax: + | field=value Equality comparison + | field!=value Inequality comparison + | field>value Greater than + | field>=value Greater than or equal + | field1" + | bd query "status=open AND priority<=2 AND updated>7d" + | bd query "(status=open OR status=blocked) AND priority<2" + | bd query "type=bug AND label=urgent" + | bd query "NOT status=closed" + | bd query "assignee=none AND type=task" + | bd query "created>30d AND status!=closed" + | bd query "label=frontend OR label=backend" + | bd query "title=authentication AND priority=0" + flag --all -a type=bool default="false" usage="Include closed issues (default: exclude closed)" + flag --limit -n type=int default="50" usage="Limit results (default: 50, 0 = unlimited)" + flag --long type=bool default="false" usage="Show detailed multi-line output for each issue" + flag --offset type=int default="0" usage="Skip the first N matching results (0-based). Only supported under --proxied-server." + flag --parse-only type=bool default="false" usage="Only parse the query and show the AST (for debugging)" + flag --reverse -r type=bool default="false" usage="Invert the sort field's default direction (created/updated/closed default to newest-first, so --sort updated --reverse is oldest-first)" + flag --sort type=string default="" usage="Sort by field: priority, created, updated, closed, status, id, title, type, assignee" + +bd quickstart + use: "quickstart" + short: "Quick start guide for bd" + group: "setup" + hidden: false + runnable: true + long: + | Display a quick start guide showing common bd workflows and patterns. + +bd ready + use: "ready" + short: "Show ready work (open, no active blockers)" + hidden: false + runnable: true + long: + | Show ready work (open issues with no active blockers). + | + | Excludes in_progress, blocked, deferred, and hooked issues. This uses the + | GetReadyWork API which applies blocker-aware semantics to find truly claimable work. + | + | Note: 'bd list --ready' uses the same blocker-aware ready-work semantics. + | + | Use --mol to filter to a specific molecule's steps: + | bd ready --mol bd-patrol # Show ready steps within molecule + | + | Use --gated to find molecules ready for gate-resume dispatch: + | bd ready --gated # Find molecules where a gate closed + | + | Use --claim to atomically claim the first ready issue matching the filters: + | bd ready --claim --json + | + | This is useful for agents executing molecules to see which steps can run next. + flag --assignee -a type=string default="" usage="Filter by assignee" + flag --brief type=bool default="false" usage="Omit the free-form text (description, design, acceptance criteria, notes, payload, waiters) from each row. Filters that read those fields still select on them. An omitted field is indistinguishable from an empty one; fetch a whole issue with bd show. Requires --json, and cannot be combined with --claim, --gated, --mol or --explain." + flag --claim type=bool default="false" usage="Atomically claim the first ready issue matching the filters" + flag --exclude-label type=stringSlice default="[]" usage="Exclude issues that have ANY of these labels" + flag --exclude-type type=stringSlice default="[]" usage="Exclude issue types from results (comma-separated or repeatable, e.g., --exclude-type=convoy,epic)" + flag --explain type=bool default="false" usage="Show dependency-aware reasoning for why issues are ready or blocked" + flag --flat type=bool default="false" usage="Alias for --plain, spelled the way bd list spells it" + flag --gated type=bool default="false" usage="Find molecules ready for gate-resume dispatch" + flag --has-metadata-key type=string default="" usage="Filter issues that have this metadata key set" + flag --include-deferred type=bool default="false" usage="Include issues with future defer_until timestamps" + flag --include-ephemeral type=bool default="false" usage="Include ephemeral issues (wisps) in results" + flag --label -l type=stringSlice default="[]" usage="Filter by labels (AND: must have ALL). Can combine with --label-any" + flag --label-any type=stringSlice default="[]" usage="Filter by labels (OR: must have AT LEAST ONE). Can combine with --label" + flag --label-pattern type=string default="" usage="Filter by label glob pattern (e.g., 'tech-*' matches tech-debt, tech-legacy)" + flag --label-regex type=string default="" usage="Filter by label regex pattern (e.g., 'tech-(debt|legacy)')" + flag --limit -n type=int default="100" usage="Maximum issues to show (use 0 for unlimited)" + flag --max-rows type=int default="0" usage="Hard upper bound on rows fetched from storage. Returns a non-zero exit (code 2) and an error to stderr if exceeded. 0 disables (the default). Overrides BEADS_MAX_ROWS for this invocation. Useful in CI/agent rigs that want a circuit breaker against pathological queries. Not supported under --proxied-server: an explicit --max-rows or BEADS_MAX_ROWS cap errors out rather than silently going unenforced." + flag --metadata-field type=stringArray default="[]" usage="Filter by metadata field (key=value, repeatable)" + flag --mol type=string default="" usage="Filter to steps within a specific molecule" + flag --mol-type type=string default="" usage="Filter by molecule type: swarm, patrol, or work" + flag --offset type=int default="0" usage="Skip the first N matching results (0-based). Only supported under --proxied-server." + flag --parent type=string default="" usage="Filter to descendants of this bead/epic" + flag --plain type=bool default="false" usage="Display issues as a plain numbered list" + flag --pretty type=bool default="true" usage="Display issues in a tree format with status/priority symbols" + flag --priority -p type=int default="0" usage="Filter by priority" + flag --sort -s type=string default="priority" usage="Sort policy: priority (default), hybrid, oldest" + flag --type -t type=string default="" usage="Filter by issue type (task, bug, feature, epic, decision, merge-request). Aliases: mr→merge-request, feat→feature, mol→molecule, dec/adr→decision" + flag --unassigned -u type=bool default="false" usage="Show only unassigned issues" + +bd recall + use: "recall " + short: "Retrieve a specific memory" + group: "setup" + hidden: false + runnable: true + long: + | Retrieve the full content of a memory by its key. + | + | Examples: + | bd recall dolt-phantoms + | bd recall auth-jwt + +bd reclaim + use: "reclaim" + short: "Revert stale-lease in_progress issues back to ready (dead-worker recovery)" + group: "issues" + hidden: false + runnable: true + long: + | Revert in_progress issues whose lease has gone stale back to ready. + | + | When a worker claims an issue it takes a lease that expires after a TTL, kept + | alive by 'bd heartbeat'. A worker that dies stops heartbeating, so its lease + | expires and its issue would otherwise stay in_progress forever. reclaim is the + | reaper: it finds in_progress issues whose lease expired more than --older-than + | ago, clears the assignee, and sets them back to open so another worker can + | claim them. The previous owner's stale lease is recorded as a recovery event. + | + | --older-than is a grace window past lease expiry: only leases that expired at + | least this long ago are reclaimed, so a worker briefly paused (GC, clock skew) + | is not robbed of live work. Run it from a supervisor on a timer with a window + | of roughly 2× the claim TTL. + | + | By default reclaim covers every stale lease THIS replica granted. The scope + | filters below narrow it further, using the same label surface claiming is + | scoped by (--label / --label-any / --exclude-label), plus --assignee and --id. + | Filters AND-combine and never widen the set: a reclaimed lease must still be + | stale. + | + | Replicas and leases (federated deployments) + | ------------------------------------------- + | A lease is only meaningful on the replica that granted it. Every other + | replica's view of the holder's liveness is stale by up to one sync interval, + | so a reaper elsewhere can revert a unit that is very much alive over there. + | reclaim therefore records the granting replica on each lease and SKIPS a lease + | another replica granted, summarizing what it declined on stderr (one line per + | run; 'bd -v' expands it to the first 20 leases individually). Reap it where it + | was granted; use --any-replica only when that replica is permanently gone (or + | when this node was renamed and its own old leases now look foreign — an + | ordinary heartbeat keeps a lease alive but does not re-home it to the node + | heartbeating it). Prefer the narrow form '--any-replica --id ': bare + | --any-replica reverts EVERY foreign stale lease, live peers included. + | + | Two invariants the guard cannot enforce for you: + | + | grace window > sync interval, and lease TTL > sync interval. + | + | A TTL or grace shorter than the cadence at which replicas exchange state is + | meaningless across the bridge — the remote view is a full interval old by + | construction. Raise the TTL/grace above the sync interval, never the reverse. + | The guard is opt-in: set BEADS_NODE_ID, or run 'bd config set node_id ' + | (which writes the per-machine ~/.config/bd/config.yaml — never commit a node_id + | to the git-tracked .beads/config.yaml, or every clone reads the same name and + | the guard goes armed-but-inert). One id per STORE, not per host: machines that + | are clients of the same dolt sql-server are ONE replica and must share one value + | or leave it unset. There is no hostname fallback — the hostname names the client + | process's machine, not the store — so an unnamed deployment keeps the old, + | unguarded behavior instead of stranding its own work. + | + | Examples: + | bd reclaim # default grace window (2× the lease TTL) + | bd reclaim --older-than 10m # reclaim leases expired >10m ago + | bd reclaim --older-than 0s # reclaim every currently-expired lease + | bd reclaim --label lane-a # only this machine's claim partition + | bd reclaim --label-any lane-a,lane-b --exclude-label pinned + | bd reclaim --assignee zelda --assignee epona # only these workers' leases + | bd reclaim --id wy-abc --id wy-def # exactly these issues + | bd reclaim --any-replica # also reap leases granted by a departed replica + flag --any-replica type=bool default="false" usage="Also reclaim leases granted by ANOTHER replica (unsafe unless that replica is gone; see 'Replicas and leases')" + flag --assignee -a type=stringSlice default="[]" usage="Only reclaim leases held by these assignees (repeatable)" + flag --exclude-label type=stringSlice default="[]" usage="Never reclaim issues carrying ANY of these labels" + flag --id type=stringSlice default="[]" usage="Only reclaim these issue IDs (repeatable)" + flag --label -l type=stringSlice default="[]" usage="Only reclaim issues with ALL these labels (AND). Can combine with --label-any" + flag --label-any type=stringSlice default="[]" usage="Only reclaim issues with AT LEAST ONE of these labels (OR). Can combine with --label" + flag --older-than type=duration default="10m0s" usage="Only reclaim leases that expired at least this long ago (grace window)" + +bd recompute-blocked + use: "recompute-blocked" + short: "Recompute is_blocked for all issues (repairs stale flags after a pull)" + group: "maint" + hidden: false + runnable: true + long: + | Recompute the denormalized is_blocked flag for every issue and wisp. + | + | is_blocked is derived from the dependency graph and maintained automatically by + | local writes and by a post-pull recompute scoped to what the merge changed. If + | that scoped recompute is skipped — a recompute that failed after its merge + | committed, or a conflicted pull resolved by hand — the flag can go stale, and a + | later pull that merges nothing will not refresh it (bd-6dnrw.37). 'bd ready' + | trusts the flag, so stale values silently hide ready work or surface blocked + | work. + | + | This command runs the full recompute unconditionally and commits the result. + | It is idempotent: on a consistent database it changes nothing. Works in every + | storage mode — embedded, server, and proxied-server (unlike 'bd doctor', which + | is server-mode only). + | + | On a workspace connected to a bd serve backend ('bd connect') it is a no-op + | that exits 0: the server maintains is_blocked on every write, and the column + | lives in the server's database, so the repair is run there, by the server's + | operator. --json then reports {"rows_corrected": 0, "maintained_by": "server"}. + | + | Examples: + | bd recompute-blocked # Repair stale is_blocked flags + | bd recompute-blocked --json # Machine-parseable {"rows_corrected": N} + +bd remember + use: "remember \"\"" + short: "Store a persistent memory" + group: "setup" + hidden: false + runnable: true + long: + | Store a memory that persists across sessions and account rotations. + | + | Memories are injected at prime time (bd prime) so you have them + | in every session without manual loading. + | + | The positional arg is the memory CONTENT (the key is auto-generated from it + | unless --key is given). As a convenience, if the arg is a bare key naming an + | existing memory, it is RECALLED instead of stored (same as 'bd recall'); + | a bare key naming nothing is refused. Use --key to store slug-like content. + | + | Corpus budget (opt-in, off by default): set the memories.budget-chars config + | key to a byte ceiling for the whole memory corpus (sum of len(key)+len(content)). + | A write that would cross it is refused, and --force overrides; a write that + | lands at or above 80% of the budget warns. With the key unset nothing changes. + | bd prime's --max-memory-chars also counts bytes, but of each memory as + | injected, formatting included, so a budget equal to that cap does not + | guarantee prime injects every memory; set the budget below it for that. + | + | Examples: + | bd remember "always run tests with -race flag" + | bd remember "Dolt phantom DBs hide in three places" --key dolt-phantoms + | bd remember "auth module uses JWT not sessions" --key auth-jwt + | bd remember dolt-phantoms # bare existing key: reads it (= bd recall) + flag --force type=bool default="false" usage="Store even when the write would cross the memories.budget-chars corpus budget (no effect when the budget is unset)" + flag --key type=string default="" usage="Explicit key for the memory (auto-generated from content if not set). If a memory with this key already exists, it will be updated in place" + +bd rename + use: "rename " + short: "Rename an issue ID" + hidden: false + runnable: true + long: + | Rename an issue from one ID to another. + | + | This updates: + | - The issue's primary ID + | - All references in other issues (descriptions, titles, notes, etc.) + | - Dependencies pointing to/from this issue + | - Labels, comments, and events + | + | Examples: + | bd rename bd-w382l bd-dolt # Rename to memorable ID + | bd rename gt-abc123 gt-auth # Use descriptive ID + | + | Note: The new ID must use a valid prefix for this database. + +bd rename-prefix + use: "rename-prefix " + short: "Rename the issue prefix for all issues in the database" + group: "maint" + hidden: false + runnable: true + long: + | Rename the issue prefix for all issues in the database. + | This will update all issue IDs and all text references across all fields. + | + | USE CASES: + | - Shortening long prefixes (e.g., 'knowledge-work-' → 'kw-') + | - Rebranding project naming conventions + | - Consolidating multiple prefixes after database corruption + | - Migrating to team naming standards + | + | Prefix validation rules: + | - Allowed characters: lowercase letters, numbers, hyphens + | - Must start with a letter + | - Must end with a hyphen (e.g., 'kw-', 'work-') + | - Cannot be empty or just a hyphen + | + | Multiple prefix detection and repair: + | If issues have multiple prefixes (corrupted database), use --repair to consolidate them. + | The --repair flag will rename all issues with incorrect prefixes to the new prefix, + | preserving issues that already have the correct prefix. + | + | EXAMPLES: + | bd rename-prefix kw- # Rename from 'knowledge-work-' to 'kw-' + | bd rename-prefix mtg- --repair # Consolidate multiple prefixes into 'mtg-' + | bd rename-prefix team- --dry-run # Preview changes without applying + | + | NOTE: This is a rare operation. Most users never need this command. + flag --dry-run type=bool default="false" usage="Preview changes without applying them" + flag --repair type=bool default="false" usage="Repair database with multiple prefixes by consolidating them" + +bd reopen + use: "reopen [id...]" + short: "Reopen one or more closed issues" + group: "issues" + hidden: false + runnable: true + long: + | Reopen closed issues by setting status to 'open' and clearing the closed_at timestamp. + | This is more explicit than 'bd update --status open' and emits a Reopened event. + | + | Exit codes: 1 for general failures; 13 when the failure is a stale + | --if-revision guard (the precondition no longer held, nothing was written — + | another actor won the race, so retrying the same guard is pointless). + flag --if-revision type=string default="" usage="Apply the write only if the issue's current revision equals this value (the decimal int64 from `bd show --json`'s \"revision\" field). One id only: refused before any write when combined with more than one issue id. A mismatch writes nothing and exits 13 (vs 1 for other failures)." + flag --reason -r type=string default="" usage="Reason for reopening" + +bd repo + use: "repo" + short: "Manage multiple repository configuration" + group: "advanced" + hidden: false + runnable: false + long: + | Configure and manage multiple repository support for multi-repo hydration. + | + | Multi-repo support allows hydrating issues from multiple beads repositories + | into a single database for unified cross-repo issue tracking. + | + | Configuration is stored in .beads/config.yaml under the 'repos' section: + | + | repos: + | primary: "." + | additional: + | - ~/beads-planning + | - ~/work-repo + | + | Examples: + | bd repo add ~/beads-planning # Add planning repo + | bd repo add ../other-repo # Add relative path repo + | bd repo list # Show all configured repos + | bd repo remove ~/beads-planning # Remove by path + | bd repo sync # Sync from all configured repos + +bd repo add + use: "add " + short: "Add an additional repository to sync" + hidden: false + runnable: true + long: + | Add a repository path to the repos.additional list in config.yaml. + | + | The path should point to a directory containing a .beads folder. + | Paths can be absolute or relative (they are stored as-is). + | + | This modifies .beads/config.yaml, which is version-controlled and + | shared across all clones of this repository. + +bd repo list + use: "list" + short: "List all configured repositories" + hidden: false + runnable: true + long: + | List all repositories configured in .beads/config.yaml. + | + | Shows the primary repository (always ".") and any additional + | repositories configured for hydration. + +bd repo remove + use: "remove " + short: "Remove a repository from sync configuration" + hidden: false + runnable: true + long: + | Remove a repository path from the repos.additional list in config.yaml. + | + | The path must exactly match what was added (e.g., if you added "~/foo", + | you must remove "~/foo", not "/home/user/foo"). + | + | This command also removes any previously-hydrated issues from the database + | that came from the removed repository. + +bd repo sync + use: "sync" + short: "Manually trigger multi-repo sync" + hidden: false + runnable: true + long: + | Synchronize issues from all configured additional repositories. + | + | Reads issues.jsonl from each additional repository and imports them into + | the primary database with their original prefixes and source_repo set. + | Uses mtime caching to skip repos whose JSONL hasn't changed. + | + | Also triggers Dolt push/pull if a remote is configured. + flag --verbose type=bool default="false" usage="Show detailed sync progress" + +bd restore + use: "restore " + short: "Restore the pre-compaction content of a compacted issue" + group: "sync" + hidden: false + runnable: true + long: + | Restore the pre-compaction content of a compacted issue. + | + | When an issue is compacted, its description/design/notes/acceptance criteria + | are summarized and the originals are archived to a compaction snapshot. This + | command recovers that original content. + | + | By default it is read-only: it displays the archived content without modifying + | the database. Pass --apply to write the original content back into the issue + | and step its compaction level back down. + | + | If no archived snapshot exists (e.g. the issue was compacted by an older bd + | before snapshot archiving), restore falls back to a best-effort reconstruction + | from Dolt version history, which can only be displayed, not applied. + flag --apply type=bool default="false" usage="Write the restored content back into the issue (default: display only)" + +bd rules + use: "rules" + short: "Audit and compact Claude rules" + group: "maint" + hidden: false + runnable: false + +bd rules audit + use: "audit" + short: "Scan rules for contradictions and merge opportunities" + hidden: false + runnable: true + flag --path type=string default=".claude/rules/" usage="Path to rules directory" + flag --threshold type=float64 default="0.6" usage="Jaccard similarity threshold" + +bd rules compact + use: "compact" + short: "Merge related rules into composites" + hidden: false + runnable: true + flag --auto type=bool default="false" usage="Apply audit suggestions" + flag --dry-run type=bool default="false" usage="Preview without applying" + flag --group type=stringSlice default="[]" usage="Rule names to merge" + flag --path type=string default=".claude/rules/" usage="Path to rules directory" + +bd schema + use: "schema" + short: "Print the JSON Schema for bd's --json / export output" + hidden: false + runnable: true + annotations: {bd:skip_store="1"} + long: + | Print the JSON Schema for bd's canonical output record types. + | + | The schema is reflected from the same Go structs bd serializes, so it stays in + | lockstep with the actual --json / export output. Use it to generate typed + | consumer models (datamodel-code-generator, quicktype, ...) rather than + | hand-maintaining them. + | + | bd schema | jq '.types.issue' # the issue record schema + | bd schema | jq '.types.dependency' # the dependency record schema + +bd search + use: "search [query]" + short: "Search issues by text query" + group: "issues" + hidden: false + runnable: true + long: + | Search issues across title and ID (all statuses, including closed). + | + | ID-like queries (e.g., "bd-123", "hq-319") use fast exact/prefix matching. + | Text queries search titles. Use --desc-contains for description search. + | Use --status open (etc.) to narrow; closed issues are included by default + | so "was this already filed/fixed?" cannot silently answer no. Matches + | beyond --limit are dropped status-blind, so when hunting live work in a + | large DB, narrow with --status open or raise --limit. + | + | Examples: + | bd search "authentication bug" + | bd search "login" --status open + | bd search "database" --label backend --limit 10 + | bd search --query "performance" --assignee alice + | bd search "bd-5q" # Search by partial ID (fast prefix match) + | bd search "security" --priority-min 0 --priority-max 2 + | bd search "bug" --created-after 2025-01-01 + | bd search "refactor" --status open # Only open issues + | bd search "bug" --sort priority + | bd search "task" --sort created --reverse + | bd search "api" --desc-contains "endpoint" + | bd search "cleanup" --no-assignee --no-labels + flag --assignee -a type=string default="" usage="Filter by assignee" + flag --closed-after type=string default="" usage="Filter issues closed after date (YYYY-MM-DD or RFC3339)" + flag --closed-before type=string default="" usage="Filter issues closed before date (YYYY-MM-DD or RFC3339)" + flag --created-after type=string default="" usage="Filter issues created after date (YYYY-MM-DD or RFC3339)" + flag --created-before type=string default="" usage="Filter issues created before date (YYYY-MM-DD or RFC3339)" + flag --desc-contains type=string default="" usage="Filter by description substring (case-insensitive)" + flag --empty-description type=bool default="false" usage="Filter issues with empty or missing description" + flag --external-contains type=string default="" usage="Filter by external ref substring (case-insensitive)" + flag --has-metadata-key type=string default="" usage="Filter issues that have this metadata key set" + flag --label -l type=stringSlice default="[]" usage="Filter by labels (AND: must have ALL)" + flag --label-any type=stringSlice default="[]" usage="Filter by labels (OR: must have AT LEAST ONE)" + flag --limit -n type=int default="50" usage="Limit results (default: 50)" + flag --long type=bool default="false" usage="Show detailed multi-line output for each issue" + flag --metadata-field type=stringArray default="[]" usage="Filter by metadata field (key=value, repeatable)" + flag --no-assignee type=bool default="false" usage="Filter issues with no assignee" + flag --no-labels type=bool default="false" usage="Filter issues with no labels" + flag --notes-contains type=string default="" usage="Filter by notes substring (case-insensitive)" + flag --priority-max type=string default="" usage="Filter by maximum priority (inclusive, 0-4 or P0-P4)" + flag --priority-min type=string default="" usage="Filter by minimum priority (inclusive, 0-4 or P0-P4)" + flag --query type=string default="" usage="Search query (alternative to positional argument)" + flag --reverse -r type=bool default="false" usage="Invert the sort field's default direction (created/updated/closed default to newest-first, so --sort updated --reverse is oldest-first)" + flag --sort type=string default="" usage="Sort by field: priority, created, updated, closed, status, id, title, type, assignee" + flag --status -s type=string default="" usage="Filter by stored status (comma-separated for OR; open, in_progress, blocked, deferred, closed, all). Default searches all statuses including closed. Note: dependency-blocked issues use 'bd blocked'" + flag --type -t type=string default="" usage="Filter by type (bug, feature, task, epic, chore, decision, message, molecule, gate, spike, story, milestone); custom types require types.custom config, and an unknown type is an error. Aliases: feat/enhancement→feature, mol→molecule, dec/adr→decision, mr→merge-request" + flag --updated-after type=string default="" usage="Filter issues updated after date (YYYY-MM-DD or RFC3339)" + flag --updated-before type=string default="" usage="Filter issues updated before date (YYYY-MM-DD or RFC3339)" + +bd send-metrics + use: "send-metrics" + short: "Internal: flush queued telemetry events (spawned by bd)" + hidden: true + runnable: true + +bd serve + use: "serve" + short: "Serve the beads HTTP API over loopback" + hidden: false + runnable: true + long: + | Serve the beads HTTP API — the same work surface the CLI answers, for + | automation clients that would otherwise fork a bd subprocess per call. + | + | The wire contract is described by an OpenAPI document (/v0); GET + | /v0/beads/context reports which operations this build actually implements. + | + | DEPLOYMENT + | + | Pass an explicit port. The default 127.0.0.1:0 takes an ephemeral one, which + | is right for ad-hoc and test use — where the bound address printed on stdout + | is read immediately — but carries no mutual exclusion: two serves against one + | workspace then run side by side on different ports with no way to enumerate + | them. On a fixed port the second one fails to bind, which is the intended + | behavior. Concurrent serves are data-safe either way; claims are arbitrated + | in the SQL server. + | + | Run it under a supervisor. bd shuts down gracefully on SIGHUP as well as + | SIGINT and SIGTERM, so closing the terminal of a foreground bd serve stops it. + | + | PROBES + | + | GET /healthz is LIVENESS only: it answers from the process and never touches + | the database, so it stays green while the database is unreachable. For + | readiness use GET /v0/beads/ready?limit=1 — a real query, where 200 means + | ready and 503 means live but not ready. + | + | AUTHENTICATION + | + | Optional, and off by default on loopback — where the trust model is the + | loopback boundary itself, the same one the database behind it already relies + | on. --auth-token-file turns it on: every operation except GET /healthz then + | requires an "Authorization: Bearer " header, GET /v0/beads/context + | included, because it reports the repo root, beads directory and database name. + | + | The file holds ONE TOKEN PER LINE and every line is accepted. That is the + | rotation mechanism: write the new token alongside the old, roll the clients + | over, then delete the old line. The file is re-read while the server runs, so + | both the addition and the removal take effect within about a second and + | neither needs a restart. Write it atomically (a temp file plus rename; a + | Kubernetes secret mount already does this). + | + | There is deliberately no --auth-token flag. A credential passed as an + | argument is readable by every local user in the process listing. + | + | --allow-non-loopback REQUIRES a token file. Beyond loopback, reaching the + | address would otherwise be the whole authorization: any peer could read every + | issue and claim work as any actor. --insecure-no-auth is the explicit, + | auditable way to say you meant that anyway. + | + | The Host allowlist is what a service deployment usually trips over first. The + | DNS-rebinding check answers only to loopback spellings and the bind address, + | so a client dialing a service name gets 400 on every request; enumerate the + | names it dials with --allowed-host (repeatable). Matching is exact — no + | wildcards — and the startup log line prints the effective allowlist. + | + | WHAT THIS DOES NOT DO + | + | No TLS. Even with a token, the credential and every issue body travel in + | plaintext, so a deployment beyond loopback has to supply confidentiality + | itself — a service mesh, or a network boundary you already trust. + | + | Hooks do not fire. A hook is a user-controlled subprocess per mutation: in a + | concurrent server that is an unbounded latency multiplier and an orphaned + | child at shutdown, and its working-directory-derived hook lookup is + | meaningless in a server process. A CLI claim runs on_update; an HTTP claim + | does not. + | + | The per-command auto-commit machinery does not run. Durability is per request: + | a successful claim commits inside its own transaction, exactly as a proxied + | CLI claim does today. + | + | An actor on an HTTP request is caller-asserted provenance for the audit trail, + | not authenticated identity — the same thing it has always been on the CLI, + | where any local process can pass any --actor. + | + | It does not run under --readonly, and refuses to start rather than binding. + | Every server it binds publishes the issue-claim operation, and the capability + | set it advertises is a property of the build rather than of the flags on the + | process that started it — so a read-only server would advertise a write it + | could never land. + | + | DESTRUCTIVE OPERATIONS + | + | POST /v0/beads/issues:sweep deletes closed beads in bulk — the operation + | behind bd purge and bd prune — and nothing it deletes comes back. It shares + | the library surface those commands call, so it inherits their guards: pinned + | beads are never swept, and a durable sweep with neither a cutoff nor an id + | pattern is refused rather than clearing every closed bead in the workspace. + | Combined with the trust model above, that means anyone who can reach this + | address can erase closed work; bind it accordingly. + flag --addr type=string default="127.0.0.1:0" usage="Address to bind as IP:PORT; the host must be a numeric IP literal, and port 0 takes an ephemeral port" + flag --allow-non-loopback type=bool default="false" usage="Permit a bind beyond loopback. Requires --auth-token-file, since reaching the address would otherwise be the whole authorization" + flag --allowed-host type=stringArray default="[]" usage="Additional Host header value to answer to, e.g. a service DNS name. Repeatable; matched exactly, with no wildcards" + flag --auth-token-file type=string default="" usage="Require an Authorization: Bearer token from this file, one token per line, all accepted. Re-read while running, so rewriting it rotates tokens without a restart (env BEADS_SERVE_TOKEN_FILE)" + flag --insecure-no-auth type=bool default="false" usage="Serve a non-loopback bind with NO authentication. Every peer that can reach the address gets full read and claim access" + flag --large-apply-ceiling type=duration default="5m0s" usage="Whole-run budget for a POST issues:batchApply request over 100 items (a ceiling, not a target; requests at or under 100 items are unaffected). Must be positive. The orchestrator's stop grace must be at least this long plus 5s, or an external SIGKILL can cut off an in-flight large apply a graceful drain would otherwise have waited out; see engdocs/SERVE_RUNBOOK.md" + +bd set-state + use: "set-state =" + short: "Set operational state (creates event + updates label)" + group: "issues" + hidden: false + runnable: true + long: + | Atomically set operational state on an issue. + | + | This command: + | 1. Creates an event bead recording the state change (source of truth) + | 2. Removes any existing label for the dimension + | 3. Adds the new dimension:value label (fast lookup cache) + | + | State labels follow the convention :, for example: + | patrol:active, patrol:muted + | mode:normal, mode:degraded + | health:healthy, health:failing + | + | Examples: + | bd set-state agent-abc patrol=muted --reason "Investigating stuck worker" + | bd set-state agent-abc mode=degraded --reason "High error rate detected" + | bd set-state agent-abc health=healthy + | + | The --reason flag provides context for the event bead (recommended). + flag --reason type=string default="" usage="Reason for the state change (recorded in event)" + +bd setup + use: "setup [recipe]" + short: "Setup integration with AI editors" + group: "setup" + hidden: false + runnable: true + long: + | Setup integration files for AI editors and coding assistants. + | + | Recipes define where beads workflow instructions are written. Built-in recipes + | include cursor, claude, copilot, gemini, aider, factory, codex, mux, opencode, junie, kiro, windsurf, cody, and kilocode. + | + | Examples: + | bd setup cursor # Install Cursor IDE integration (rules + agent hooks) + | bd setup cursor --global # Install global Cursor hooks (~/.cursor/hooks.json) + | bd setup kiro # Install Kiro steering guidance + | bd setup codex # Install Codex skill + AGENTS.md guidance + native hooks + | bd setup codex --global # Install global Codex skill + guidance + native hooks + | bd setup copilot # Install Copilot CLI plugin + repository instructions + | bd setup mux --project # Install Mux workspace layer (.mux/AGENTS.md) + | bd setup mux --global # Install Mux global layer (~/.mux/AGENTS.md) + | bd setup mux --project --global # Install both Mux layers + | bd setup --list # Show all available recipes + | bd setup --print # Print the template to stdout + | bd setup -o rules.md # Write template to custom path + | bd setup --add myeditor .myeditor/rules.md # Add custom recipe + | + | Use 'bd setup --check' to verify installation status. + | Use 'bd setup --remove' to uninstall. + flag --add type=string default="" usage="Add a custom recipe with given name" + flag --check type=bool default="false" usage="Check if integration is installed" + flag --global type=bool default="false" usage="Install globally (claude/codex/cursor/mux; writes to ~/.claude/settings.json, $CODEX_HOME/AGENTS.md or ~/.codex/AGENTS.md, ~/.cursor/hooks.json, or ~/.mux/AGENTS.md)" + flag --list type=bool default="false" usage="List all available recipes" + flag --output -o type=string default="" usage="Write template to custom path" + flag --print type=bool default="false" usage="Print the template to stdout" + flag --project type=bool default="false" usage="Install for this project only (gemini/mux)" + flag --remove type=bool default="false" usage="Remove the integration" + flag --stealth type=bool default="false" usage="Use stealth mode (claude/gemini)" + +bd ship + use: "ship " + short: "Publish a capability for cross-project dependencies" + hidden: false + runnable: true + long: + | Ship a capability to satisfy cross-project dependencies. + | + | This command: + | 1. Finds issue with export: label + | 2. Validates issue is closed (or --force to override) + | 3. Adds provides: label + | + | External projects can depend on this capability using: + | bd dep add external:: + | + | The capability is resolved when the external project has a closed issue + | with the provides: label. + | + | Examples: + | bd ship mol-run-assignee # Ship the mol-run-assignee capability + | bd ship mol-run-assignee --force # Ship even if issue is not closed + | bd ship mol-run-assignee --dry-run # Preview without making changes + flag --dry-run type=bool default="false" usage="Preview without making changes" + flag --force type=bool default="false" usage="Ship even if issue is not closed" + +bd show + use: "show [id...] [--id=...] [--current]" + aliases: ["view"] + short: "Show issue details" + group: "issues" + hidden: false + runnable: true + flag --as-of type=string default="" usage="Show issue as it existed at a specific commit hash or branch (requires Dolt; commit hashes must be the full 32-character hash from 'bd history', not a prefix)" + flag --brief-deps type=bool default="false" usage="Reduce each dependency to its identity fields in JSON output (--json only; drops description, design, notes and acceptance criteria)" + flag --children type=bool default="false" usage="Show only the children of this issue" + flag --comments-tail type=int default="0" usage="Render only the last N comments in text output, preceded by one elision line naming how many older ones were hidden (text output only; 0, the default, renders every comment unchanged; N must be >= 0)" + flag --current type=bool default="false" usage="Show the currently active issue (in-progress, hooked, or last touched)" + flag --id type=stringArray default="[]" usage="Issue ID (use for IDs that look like flags, e.g., --id=gt--xyz)" + flag --include-comments type=bool default="false" usage="Stream full comment bodies in JSON output (--json only; may be slow on issues with many comments). Without it the comments field is absent entirely, not truncated: an issue with comments carries comment_count and comments_omitted=true, so check those before reading an absent comments field as none." + flag --include-dependents type=bool default="false" usage="Stream full dependent issues in JSON output (--json only; may be slow on hub beads)" + flag --local-time type=bool default="false" usage="Show timestamps in local time instead of UTC (date-only fields are always local)" + flag --long type=bool default="false" usage="Show all available fields (extended metadata, agent identity, gate fields, etc.)" + flag --refs type=bool default="false" usage="Show issues that reference this issue (reverse lookup)" + flag --short type=bool default="false" usage="Show compact one-line output per issue" + flag --thread type=bool default="false" usage="Show full conversation thread (for messages)" + flag --watch -w type=bool default="false" usage="Watch for changes and auto-refresh display" + +bd sql + use: "sql " + short: "Execute raw SQL against the beads database" + group: "maint" + hidden: false + runnable: true + long: + | Execute a raw SQL query against the underlying database (Dolt). + | + | Useful for debugging, maintenance, and working around bugs in higher-level commands. + | + | Examples: + | bd sql 'SELECT COUNT(*) FROM issues' + | bd sql 'SELECT id, title FROM issues WHERE status = "open" LIMIT 5' + | bd sql 'DELETE FROM dirty_issues WHERE issue_id = "bd-abc123"' + | bd sql --csv 'SELECT id, title, status FROM issues' + | + | The query is passed directly to the database. Reads (SELECT, WITH ... SELECT, + | SHOW, EXPLAIN) return results as a table (or JSON/CSV with --json/--csv). Writes + | (INSERT, UPDATE, DELETE, DDL) report the number of rows affected. Statements + | that may both write and return rows, such as CALL, are committed and print any + | rows they return (or "OK"). + | + | In proxied-server mode, multiple statements separated by ';' run as a single + | committed batch and report "OK", and --database runs the query against a + | different server database (equivalent to a session USE) without changing the + | project's configured database. + | + | WARNING: Direct database access bypasses the storage layer. Use with caution. + flag --csv type=bool default="false" usage="Output results in CSV format" + +bd stale + use: "stale" + short: "Show stale issues (not updated recently)" + group: "views" + hidden: false + runnable: true + long: + | Show issues that haven't been updated recently and may need attention. + | This helps identify: + | - In-progress issues with no recent activity (may be abandoned) + | - Open issues that have been forgotten + | - Issues that might be outdated or no longer relevant + flag --days -d type=int default="30" usage="Issues not updated in this many days" + flag --exclude-label type=stringSlice default="[]" usage="Exclude issues that have ANY of these labels" + flag --label -l type=stringSlice default="[]" usage="Filter by labels (AND: must have ALL). Can combine with --label-any" + flag --label-any type=stringSlice default="[]" usage="Filter by labels (OR: must have AT LEAST ONE). Can combine with --label" + flag --limit -n type=int default="50" usage="Maximum issues to show" + flag --status -s type=string default="" usage="Filter by status (open|in_progress|blocked|deferred)" + +bd state + use: "state " + short: "Query the current value of a state dimension" + group: "issues" + hidden: false + runnable: true + long: + | Query the current value of a state dimension from an issue's labels. + | + | State labels follow the convention :, for example: + | patrol:active + | mode:degraded + | health:healthy + | + | This command extracts the value for a given dimension. + | + | Examples: + | bd state witness-abc patrol # Output: active + | bd state witness-abc mode # Output: normal + | bd state witness-abc health # Output: healthy + +bd state list + use: "list " + short: "List all state dimensions on an issue" + hidden: false + runnable: true + long: + | List all state labels (dimension:value format) on an issue. + | + | This filters labels to only show those following the state convention. + | + | Example: + | bd state list witness-abc + | # Output: + | # patrol: active + | # mode: normal + | # health: healthy + +bd status + use: "status" + aliases: ["stats"] + short: "Show issue database overview and statistics" + group: "views" + hidden: false + runnable: true + long: + | Show a quick snapshot of the issue database state and statistics. + | + | This command provides a summary of issue counts by state (open, in_progress, + | blocked, closed), ready work, extended statistics (pinned issues, + | average lead time), and recent activity over the last 24 hours from git history. + | + | Similar to how 'git status' shows working tree state, 'bd status' gives you + | a quick overview of your issue database without needing multiple queries. + | + | Use cases: + | - Quick project health check + | - Onboarding for new contributors + | - Integration with shell prompts or CI/CD + | - Daily standup reference + | - Fast CI status checks that don't need blocked-count accuracy + | + | Examples: + | bd status # Show summary with activity + | bd status --no-activity # Skip git activity (faster) + | bd status --no-blocked # Skip slow blocked-count scan (faster) + | bd stats --no-blocked --json # JSON output without blocked count + | bd status --json # JSON format output + | bd status --assigned # Show issues assigned to current user + | bd stats # Alias for bd status + flag --all type=bool default="false" usage="Show all issues (default behavior)" + flag --assigned type=bool default="false" usage="Show issues assigned to current user" + flag --no-activity type=bool default="false" usage="Skip git activity summary (faster)" + flag --no-blocked type=bool default="false" usage="Skip blocked-count computation (faster on large rigs; not supported in proxied-server mode)" + +bd statuses + use: "statuses" + short: "List valid issue statuses" + group: "views" + hidden: false + runnable: true + long: + | List all valid issue statuses and their categories. + | + | Built-in statuses (open, in_progress, blocked, etc.) are always valid. + | Additional statuses can be configured via status.custom: + | + | bd config set status.custom "in_review:active,qa_testing:wip,on_hold:frozen" + | + | Categories control behavior: + | active — appears in 'bd ready' and default 'bd list' + | wip — excluded from 'bd ready', visible in default 'bd list' + | done — excluded from 'bd ready' and default 'bd list' + | frozen — excluded from 'bd ready' and default 'bd list' + | + | Statuses without a category (legacy format) are valid but excluded from 'bd ready'. + | + | Examples: + | bd statuses # List all statuses with icons and categories + | bd statuses --json # Output as JSON + | + +bd supersede + use: "supersede --with " + short: "Mark an issue as superseded by a replacement issue" + group: "deps" + hidden: false + runnable: true + long: + | Mark an issue as superseded by a different (replacement) issue. + | + | The superseded issue is automatically closed with a reference to the replacement. + | Useful for design docs, specs, and evolving artifacts. + | + | Examples: + | bd supersede bd-old --with bd-new # Mark bd-old as superseded by bd-new + flag --with type=string default="" annotations={cobra_annotation_bash_completion_one_required_flag=["true"]} usage="Replacement issue ID (required)" + +bd swarm + use: "swarm" + short: "Swarm management for structured epics" + group: "deps" + hidden: false + runnable: false + long: + | Swarm management commands for coordinating parallel work on epics. + | + | A swarm is a structured body of work defined by an epic and its children, + | with dependencies forming a DAG (directed acyclic graph) of work. + +bd swarm create + use: "create [epic-id]" + short: "Create a swarm molecule from an epic" + hidden: false + runnable: true + long: + | Create a swarm molecule to orchestrate parallel work on an epic. + | + | The swarm molecule: + | - Links to the epic it orchestrates + | - Has mol_type=swarm for discovery + | - Specifies a coordinator (optional) + | - Can be picked up by any coordinator agent + | + | If given a single issue (not an epic), it will be auto-wrapped: + | - Creates an epic with that issue as its only child + | - Then creates the swarm molecule for that epic + | + | Examples: + | bd swarm create bd-epic-123 # Create swarm for epic + | bd swarm create bd-epic-123 --coordinator=observer/ # With specific coordinator + | bd swarm create bd-task-456 # Auto-wrap single issue + flag --coordinator type=string default="" usage="Coordinator address (e.g., my-project/witness)" + flag --force type=bool default="false" usage="Create new swarm even if one already exists" + +bd swarm list + use: "list" + short: "List all swarm molecules" + hidden: false + runnable: true + long: + | List all swarm molecules with their status. + | + | Shows each swarm molecule with: + | - Progress (completed/total issues) + | - Active workers + | - Epic ID and title + | + | Examples: + | bd swarm list # List all swarms + | bd swarm list --json # Machine-readable output + +bd swarm status + use: "status [epic-or-swarm-id]" + short: "Show current swarm status" + hidden: false + runnable: true + long: + | Show the current status of a swarm, computed from beads. + | + | Accepts either: + | - An epic ID (shows status for that epic's children) + | - A swarm molecule ID (follows the link to find the epic) + | + | Displays issues grouped by state: + | - Completed: Closed issues + | - Active: Issues currently in_progress (with assignee) + | - Ready: Open issues with all dependencies satisfied + | - Blocked: Open issues waiting on dependencies + | + | The status is COMPUTED from beads, not stored separately. + | If beads changes, status changes. + | + | Examples: + | bd swarm status gt-epic-123 # Show swarm status by epic + | bd swarm status gt-swarm-456 # Show status via swarm molecule + | bd swarm status gt-epic-123 --json # Machine-readable output + +bd swarm validate + use: "validate [epic-id]" + short: "Validate epic structure for swarming" + hidden: false + runnable: true + long: + | Validate an epic's structure to ensure it's ready for swarm execution. + | + | Checks for: + | - Correct dependency direction (requirement-based, not temporal) + | - Orphaned issues (roots with no dependents) + | - Missing dependencies (leaves that should depend on something) + | - Cycles (impossible to resolve) + | - Disconnected subgraphs + | + | Reports: + | - Ready fronts (waves of parallel work) + | - Estimated worker-sessions + | - Maximum parallelism + | - Warnings for potential issues + | + | Examples: + | bd swarm validate gt-epic-123 # Validate epic structure + | bd swarm validate gt-epic-123 --verbose # Include detailed issue graph + flag --verbose type=bool default="false" usage="Include detailed issue graph in output" + +bd sync + use: "sync" + short: "Pull, check for conflicts, repair is_blocked, and push (the federation loop)" + group: "sync" + hidden: false + runnable: true + long: + | Run one full synchronization cycle against the Dolt remote. + | + | This is the loop every multi-machine beads deployment otherwise hand-rolls in + | shell: + | + | 1. pull from the remote + | 2. check for merge conflicts POSITIVELY, from the merge's own conflict rows + | and from Dolt's conflict tables — never inferred from the pull's exit + | status, which is not a trustworthy conflict signal in either direction + | 3. recompute the denormalized is_blocked flag, so dependency edges merged in + | from another replica do not leave 'bd ready' stale + | 4. push, retrying a bounded number of times when another replica wins the + | push race + | + | The repair in step 3 refuses to run while another writer has uncommitted changes + | to issues/dependencies. That is transient and not this sync's doing, so it is + | retried on the same budget as a push race rather than failing the run. A working + | set that is NOT transient exits 4 instead, because no amount of retrying will + | ever publish and only an operator can clear it. Two kinds of evidence say so: + | constraint violations on the dirty tables are detected positively and escalate + | on the very attempt that finds them; an abandoned uncommitted edit has no such + | positive signal, so it is only inferred once the same pending graph edits have + | blocked every attempt of several consecutive runs. + | + | Conflicts sync cannot resolve safely are NEVER auto-resolved: it halts before + | recomputing or pushing and exits 2, and repeated runs keep halting the same way + | until an operator resolves the divergence. (The pull underneath does auto-settle + | the conflict classes it can settle convergently — machine-local metadata, + | audit-only dependency rows, and last-write-wins on issue cells. Anything beyond + | those halts here.) Whether the halted merge was aborted or left live in the + | working set depends on the pull route, so the halt message reports which. + | + | Exit codes (a sync timer can branch on these without parsing output): + | + | 0 synced, or nothing to do + | 1 error (transport, auth, storage) + | 2 merge conflict — halted, nothing pushed, resolve it by hand + | 3 retries exhausted (push race, or a concurrent writer's dirty working set) + | — transient, nothing pushed, retry on the next tick + | 4 the dirty working set is stuck, not busy: identical pending graph edits + | blocked every attempt of several consecutive runs — nothing pushed, and no + | later tick will publish until an operator clears it + | + | On the default-remote path, a rig with no Dolt remote yet but a git origin + | configured adopts that origin as its Dolt remote first, exactly as 'bd dolt push' + | does — so 'bd sync' works as a first-time federation bring-up step instead of + | reporting 'no remote' and doing nothing. Passing --remote never adopts anything. + | + | This is not 'bd federation sync', which syncs with named peer towns and takes a + | --strategy ours|theirs to resolve whatever conflicts it meets. 'bd sync' targets + | the configured remote and has no such switch: what it cannot settle, it halts on. + | + | Examples: + | bd sync # sync with the default remote + | bd sync --remote mini # sync with a specific remote + | bd sync --attempts 5 # allow more push-race retries + | bd sync --json # machine-parseable outcome + flag --attempts type=int default="3" usage="Maximum pull/push attempts before reporting a transient retry exhaustion (exit 3)" + flag --no-adopt type=bool default="false" usage="Never derive a Dolt remote from git origin (also BD_NO_REMOTE_ADOPT=1)" + flag --remote type=string default="" usage="Sync with a specific named remote instead of the default" + flag --yes -y type=bool default="false" usage="Consent to adopting a Dolt remote derived from git origin when none is configured" + +bd tag + use: "tag