fix: clarify signaling token debug semantics in project CLI - #71
Open
littleDogWang wants to merge 1 commit into
Open
littleDogWang wants to merge 1 commit into
littleDogWang wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
project doctortreated the Console signaling Token debugging switch as token issuance capability. When the switch was off, it emittedTOKEN_CAPABILITY_DISABLEDand returned exit code 2 even for an otherwise ready project. The CLI now names that statussignalingTokenDebugEnabledinproject showand no longer uses the debug switch as a readiness gate. The BFF wire field remainstokenEnabledfor compatibility with the existing service.Type of change
error.coderename/removal)Public-contract impact
project show --jsonreturnsdata.signalingTokenDebugEnabledinstead ofdata.tokenEnabled. The boolean value is unchanged (truecorresponds toneed_token=0).error.code: the misleadingTOKEN_CAPABILITY_DISABLEDwarning is removed.project doctornow exits 0 instead of 2.Before:
project show --jsonincluded"tokenEnabled": false;project doctor --jsonreturned"status":"warning","ok":false, and exit code 2 for the same project.After:
project show --jsonincludes"signalingTokenDebugEnabled": false;project doctor --jsonreturns"status":"healthy","ok":true, and exit code 0 when no other issue exists. Prettyproject showlabels the valueSignaling Token Debug.Test plan
go test ./...passed in an isolated temporary checkout. The local home directory has a.agora/project.jsonbinding that otherwise contaminates existing integration tests.make lintpassed its gofmt, error-code coverage, and generated-doc checks in the isolated checkout.golangci-lintwas not installed, so its optional check did not run.project showbehavior are covered byTestCLIProjectUseShowFeatureAndDoctorHappyPath.TestBuildProjectDoctorIgnoresSignalingTokenDebug.Documentation
CHANGELOG.mdupdated.docs/automation.mdupdated with the field migration.docs/error-codes.mdupdated to remove the warning and correct the App ID check description.Security checklist
unsafeimport.