Skip to content

feat: Add --trigger to await-pause-point for one-command verification #1920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hatayama merged 4 commits into from
Jul 21, 2026
Merged

feat: Add --trigger to await-pause-point for one-command verification #1920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a4f87c3
Add --trigger flag to await-pause-point/enable-pause-point --await
hatayama Jul 21, 2026
c0766d5
Add regression harness scenario for await-pause-point --trigger
hatayama Jul 21, 2026
94cb67c
Confirm the marker is armed before dispatching --trigger
hatayama Jul 21, 2026
9a5fc98
Always populate TriggerResult when --trigger was given, even on skip
hatayama Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions cli/project-runner/internal/projectrunner/native_command_help.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const (
PausePointCapturedVariablesFlagName = "captured-variables"
PausePointCapturedVariableNamesFlagName = "captured-variable-names"
PausePointExpectFlagName = "expect"
PausePointTriggerFlagName = "trigger"
)

// runnerNativeCommandOptions lists the flags accepted by each runner-owned
Expand All @@ -32,6 +33,7 @@ var runnerNativeCommandOptions = map[string][]string{
"--" + PausePointCapturedVariablesFlagName,
"--" + PausePointCapturedVariableNamesFlagName,
"--" + PausePointExpectFlagName,
"--" + PausePointTriggerFlagName,
},
clicore.PausePointStatusUserCommandName: {
"--" + PausePointIDFlagName,
Expand Down
68 changes: 53 additions & 15 deletions cli/project-runner/internal/projectrunner/pause_point_enable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,21 @@ const pausePointEnableCommandName = "enable-pause-point"
const pausePointEnableAwaitFlagName = "await"

// extractPausePointEnableAwaitFlags pulls the CLI-only --await/--captured-variables/
// --captured-variable-names/--expect flags out of enable-pause-point args before generic schema
// parsing, because none of them are part of the Unity-side EnablePausePointSchema.
// --captured-variable-names/--expect/--trigger flags out of enable-pause-point args before
// generic schema parsing, because none of them are part of the Unity-side EnablePausePointSchema.
func extractPausePointEnableAwaitFlags(
args []string,
) ([]string, bool, pausePointCapturedVariablesMode, []string, []pausePointExpectation, error) {
) ([]string, bool, pausePointCapturedVariablesMode, []string, []pausePointExpectation, string, []string, error) {
remaining := make([]string, 0, len(args))
await := false
mode := pausePointCapturedVariablesModeFull
modeSet := false
var capturedVariableNames []string
namesSet := false
var expectations []pausePointExpectation
var triggerCommand string
var triggerArgs []string
triggerSet := false

for index := 0; index < len(args); index++ {
arg := args[index]
Expand All @@ -46,18 +49,40 @@ func extractPausePointEnableAwaitFlags(
continue
}

if isPausePointFlag(arg, PausePointTriggerFlagName) {
name, value, consumedNext, err := clicore.ParseFlagValue(arg, args, index)
if err != nil {
return nil, false, mode, nil, nil, "", nil, err
}
if name != PausePointTriggerFlagName {
remaining = append(remaining, arg)
continue
}
parsedCommand, parsedArgs, parseErr := parsePausePointTriggerCommand(pausePointEnableCommandName, value)
if parseErr != nil {
return nil, false, mode, nil, nil, "", nil, parseErr
}
triggerCommand = parsedCommand
triggerArgs = parsedArgs
triggerSet = true
if consumedNext {
index++
}
continue
}

if isPausePointFlag(arg, PausePointCapturedVariablesFlagName) {
name, value, consumedNext, err := clicore.ParseFlagValue(arg, args, index)
if err != nil {
return nil, false, mode, nil, nil, err
return nil, false, mode, nil, nil, "", nil, err
}
if name != PausePointCapturedVariablesFlagName {
remaining = append(remaining, arg)
continue
}
parsedMode, err := parsePausePointCapturedVariablesMode(value)
if err != nil {
return nil, false, mode, nil, nil, err
return nil, false, mode, nil, nil, "", nil, err
}
mode = parsedMode
modeSet = true
Expand All @@ -70,7 +95,7 @@ func extractPausePointEnableAwaitFlags(
if isPausePointFlag(arg, PausePointCapturedVariableNamesFlagName) {
name, value, consumedNext, err := clicore.ParseFlagValue(arg, args, index)
if err != nil {
return nil, false, mode, nil, nil, err
return nil, false, mode, nil, nil, "", nil, err
}
if name != PausePointCapturedVariableNamesFlagName {
remaining = append(remaining, arg)
Expand All @@ -87,15 +112,15 @@ func extractPausePointEnableAwaitFlags(
if isPausePointFlag(arg, PausePointExpectFlagName) {
name, value, consumedNext, err := clicore.ParseFlagValue(arg, args, index)
if err != nil {
return nil, false, mode, nil, nil, err
return nil, false, mode, nil, nil, "", nil, err
}
if name != PausePointExpectFlagName {
remaining = append(remaining, arg)
continue
}
expectation, parseErr := parsePausePointExpectFlagValue(value)
if parseErr != nil {
return nil, false, mode, nil, nil, parseErr
return nil, false, mode, nil, nil, "", nil, parseErr
}
expectations = append(expectations, expectation)
if consumedNext {
Expand All @@ -107,16 +132,18 @@ func extractPausePointEnableAwaitFlags(
remaining = append(remaining, arg)
}

if !await && (modeSet || namesSet || len(expectations) > 0) {
if !await && (modeSet || namesSet || len(expectations) > 0 || triggerSet) {
option := "--" + PausePointCapturedVariablesFlagName
switch {
case triggerSet:
option = "--" + PausePointTriggerFlagName
case len(expectations) > 0:
option = "--" + PausePointExpectFlagName
case namesSet:
option = "--" + PausePointCapturedVariableNamesFlagName
}
return nil, false, mode, nil, nil, &clierrors.ArgumentError{
Message: "--captured-variables, --captured-variable-names, and --expect require --await",
return nil, false, mode, nil, nil, "", nil, &clierrors.ArgumentError{
Message: "--captured-variables, --captured-variable-names, --expect, and --trigger require --await",
Option: option,
Command: pausePointEnableCommandName,
NextActions: []string{
Expand All @@ -125,7 +152,7 @@ func extractPausePointEnableAwaitFlags(
}
}

return remaining, await, mode, capturedVariableNames, expectations, nil
return remaining, await, mode, capturedVariableNames, expectations, triggerCommand, triggerArgs, nil
}

func isPausePointFlag(arg string, flagName string) bool {
Expand All @@ -140,7 +167,7 @@ func runEnablePausePointCommand(
stdout io.Writer,
stderr io.Writer,
) int {
remainingArgs, await, capturedVariablesMode, capturedVariableNames, expectations, err := extractPausePointEnableAwaitFlags(args)
remainingArgs, await, capturedVariablesMode, capturedVariableNames, expectations, triggerCommand, triggerArgs, err := extractPausePointEnableAwaitFlags(args)
if err != nil {
clierrors.WriteClassifiedError(stderr, err, clierrors.ErrorContext{
ProjectRoot: connection.ProjectRoot,
Expand Down Expand Up @@ -192,7 +219,8 @@ func runEnablePausePointCommand(
}

return runEnablePausePointAndAwait(
ctx, connection, params, capturedVariablesMode, capturedVariableNames, expectations, stdout, stderr)
ctx, connection, params, capturedVariablesMode, capturedVariableNames, expectations,
triggerCommand, triggerArgs, startPath, stdout, stderr)
}

// runEnablePausePointAndAwait sends the same single enable-pause-point IPC request the
Expand All @@ -206,6 +234,9 @@ func runEnablePausePointAndAwait(
capturedVariablesMode pausePointCapturedVariablesMode,
capturedVariableNames []string,
expectations []pausePointExpectation,
triggerCommand string,
triggerArgs []string,
startPath string,
stdout io.Writer,
stderr io.Writer,
) int {
Expand Down Expand Up @@ -254,6 +285,9 @@ func runEnablePausePointAndAwait(
capturedVariablesMode: capturedVariablesMode,
capturedVariableNames: capturedVariableNames,
expectations: expectations,
triggerCommand: triggerCommand,
triggerArgs: triggerArgs,
startPath: startPath,
}

return runPausePointWaitAfterEnable(ctx, connection, waitOptions, enableResponse.Warning, stdout, stderr)
Expand All @@ -272,7 +306,7 @@ func runPausePointWaitAfterEnable(
stderr io.Writer,
) int {
spinner := clicore.NewToolSpinner(stderr, pausePointEnableCommandName)
response, state, err := waitForPausePoint(ctx, connection, options)
response, state, triggerResult, err := waitForPausePoint(ctx, connection, options)
spinner.Stop()
if err != nil {
clierrors.WriteClassifiedError(stderr, err, clierrors.ErrorContext{
Expand All @@ -287,6 +321,7 @@ func runPausePointWaitAfterEnable(
// narrow or strip values, same as the plain await-pause-point path.
expectations := evaluatePausePointExpectations(response.CapturedVariables, options.expectations)

response.TriggerResult = triggerResult
response = filterPausePointCapturedVariableHistory(response)
response = filterPausePointCapturedVariablesByName(response, options.capturedVariableNames)
response = applyPausePointCapturedVariablesMode(response, options.capturedVariablesMode)
Expand Down Expand Up @@ -341,6 +376,9 @@ func runPausePointWaitAfterEnable(
if enableWarning != "" {
waitErr.Details["EnableWarning"] = enableWarning
}
if triggerResult != nil {
waitErr.Details["TriggerResult"] = triggerResult
}
if state == pausePointWaitStateTimeout {
logs, logsErr := fetchMatchingLogs(ctx, connection, options.id, options.matchingLogsMaxCount)
if logsErr == nil {
Expand Down
12 changes: 6 additions & 6 deletions cli/project-runner/internal/projectrunner/pause_point_enable_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (

// Verifies --await is extracted and the remaining args are left untouched for schema parsing.
func TestExtractPausePointEnableAwaitFlagsExtractsAwait(t *testing.T) {
remaining, await, mode, names, expectations, err := extractPausePointEnableAwaitFlags([]string{"--id", "jump", "--await"})
remaining, await, mode, names, expectations, _, _, err := extractPausePointEnableAwaitFlags([]string{"--id", "jump", "--await"})
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
Expand All @@ -39,7 +39,7 @@ func TestExtractPausePointEnableAwaitFlagsExtractsAwait(t *testing.T) {

// Verifies --captured-variables/--captured-variable-names are extracted alongside --await.
func TestExtractPausePointEnableAwaitFlagsExtractsCapturedVariableOptions(t *testing.T) {
remaining, await, mode, names, _, err := extractPausePointEnableAwaitFlags([]string{
remaining, await, mode, names, _, _, _, err := extractPausePointEnableAwaitFlags([]string{
"--id", "jump", "--await", "--captured-variables", "names", "--captured-variable-names", "a,b",
})
if err != nil {
Expand All @@ -61,7 +61,7 @@ func TestExtractPausePointEnableAwaitFlagsExtractsCapturedVariableOptions(t *tes

// Verifies --expect is extracted (repeatably) alongside --await, and unrelated args are untouched.
func TestExtractPausePointEnableAwaitFlagsExtractsExpect(t *testing.T) {
remaining, await, _, _, expectations, err := extractPausePointEnableAwaitFlags([]string{
remaining, await, _, _, expectations, _, _, err := extractPausePointEnableAwaitFlags([]string{
"--id", "jump", "--await", "--expect", "Health=100", "--expect", "Name=Enemy",
})
if err != nil {
Expand All @@ -86,7 +86,7 @@ func TestExtractPausePointEnableAwaitFlagsExtractsExpect(t *testing.T) {

// Verifies --captured-variables without --await is rejected, since it has no effect otherwise.
func TestExtractPausePointEnableAwaitFlagsRequiresAwaitForCapturedVariables(t *testing.T) {
_, _, _, _, _, err := extractPausePointEnableAwaitFlags([]string{"--id", "jump", "--captured-variables", "names"})
_, _, _, _, _, _, _, err := extractPausePointEnableAwaitFlags([]string{"--id", "jump", "--captured-variables", "names"})
if err == nil {
t.Fatalf("expected an error")
}
Expand All @@ -97,7 +97,7 @@ func TestExtractPausePointEnableAwaitFlagsRequiresAwaitForCapturedVariables(t *t

// Verifies --expect without --await is rejected, since it has no effect otherwise.
func TestExtractPausePointEnableAwaitFlagsRequiresAwaitForExpect(t *testing.T) {
_, _, _, _, _, err := extractPausePointEnableAwaitFlags([]string{"--id", "jump", "--expect", "Health=100"})
_, _, _, _, _, _, _, err := extractPausePointEnableAwaitFlags([]string{"--id", "jump", "--expect", "Health=100"})
if err == nil {
t.Fatalf("expected an error")
}
Expand All @@ -108,7 +108,7 @@ func TestExtractPausePointEnableAwaitFlagsRequiresAwaitForExpect(t *testing.T) {

// Verifies enable-pause-point without --await leaves File/Line/Id/Mode args untouched.
func TestExtractPausePointEnableAwaitFlagsWithoutAwaitLeavesArgsUnchanged(t *testing.T) {
remaining, await, _, _, _, err := extractPausePointEnableAwaitFlags([]string{"--file", "Assets/Foo.cs", "--line", "10"})
remaining, await, _, _, _, _, _, err := extractPausePointEnableAwaitFlags([]string{"--file", "Assets/Foo.cs", "--line", "10"})
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
Expand Down
Loading