Skip to content

issues 612: providing more info in default output for workflow show command #1021

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

Open
hussam-salah wants to merge 1 commit into
base: main
Choose a base branch
from
Open

issues 612: providing more info in default output for workflow show command #1021

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
57 changes: 53 additions & 4 deletions internal/temporalcli/commands.workflow_exec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,6 +725,9 @@ type structuredHistoryIter struct {
reverseBuf []*history.HistoryEvent
reverseNextToken []byte
reverseStarted bool

// Tracks event times by event ID for computing durations in Details column
eventTimes map[int64]time.Time
}

func (s *structuredHistoryIter) print(cctx *CommandContext) error {
Expand Down Expand Up @@ -772,7 +775,8 @@ type structuredHistoryEvent struct {
Time string `cli:",width=20"`
// We're going to set width to a semi-reasonable number for good header
// placement, but we expect it to extend past for larger
Type string `cli:",width=26"`
Type string `cli:",width=26"`
Details string `cli:",width=36"`
}

var structuredHistoryEventType = reflect.TypeOf(structuredHistoryEvent{})
Expand All @@ -785,11 +789,18 @@ func (s *structuredHistoryIter) Next() (any, error) {
if event == nil {
return nil, nil
}
// Track event time for duration calculations in Details
if s.eventTimes == nil {
s.eventTimes = make(map[int64]time.Time)
}
s.eventTimes[event.EventId] = event.EventTime.AsTime()

// Build data
data := structuredHistoryEvent{
ID: event.EventId,
Time: event.EventTime.AsTime().Format(time.RFC3339),
Type: coloredEventType(event.EventType),
ID: event.EventId,
Time: event.EventTime.AsTime().Format(time.RFC3339),
Type: coloredEventType(event.EventType),
Details: s.eventDetails(event),
}

// Follow continue as new (forward only; reverse traversal stays within the requested run)
Expand All @@ -802,6 +813,44 @@ func (s *structuredHistoryIter) Next() (any, error) {
return data, nil
}

func (s *structuredHistoryIter) eventDetails(event *history.HistoryEvent) string {
const maxLen = 40
var detail string
switch {
case event.GetWorkflowExecutionStartedEventAttributes() != nil:
if wt := event.GetWorkflowExecutionStartedEventAttributes().WorkflowType; wt != nil {
detail = wt.Name
}
case event.GetWorkflowTaskScheduledEventAttributes() != nil:
if tq := event.GetWorkflowTaskScheduledEventAttributes().TaskQueue; tq != nil {
detail = tq.Name
}
case event.GetWorkflowTaskStartedEventAttributes() != nil:
attr := event.GetWorkflowTaskStartedEventAttributes()
if scheduledTime, ok := s.eventTimes[attr.ScheduledEventId]; ok {
detail = event.EventTime.AsTime().Sub(scheduledTime).Truncate(time.Millisecond).String()
}
case event.GetWorkflowTaskCompletedEventAttributes() != nil:
attr := event.GetWorkflowTaskCompletedEventAttributes()
if startedTime, ok := s.eventTimes[attr.StartedEventId]; ok {
detail = event.EventTime.AsTime().Sub(startedTime).Truncate(time.Millisecond).String()
}
case event.GetStartChildWorkflowExecutionInitiatedEventAttributes() != nil:
if wt := event.GetStartChildWorkflowExecutionInitiatedEventAttributes().WorkflowType; wt != nil {
detail = wt.Name
}
case event.GetChildWorkflowExecutionCompletedEventAttributes() != nil:
attr := event.GetChildWorkflowExecutionCompletedEventAttributes()
if initiatedTime, ok := s.eventTimes[attr.InitiatedEventId]; ok {
detail = event.EventTime.AsTime().Sub(initiatedTime).Truncate(time.Millisecond).String()
}
}
if len(detail) > maxLen {
return detail[:maxLen-3] + "..."
}
return detail
}

func (s *structuredHistoryIter) NextRawEvent() (*history.HistoryEvent, error) {
if s.reverse {
return s.nextRawEventReverse()
Expand Down
4 changes: 2 additions & 2 deletions internal/temporalcli/commands.workflow_exec_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,8 @@ func (s *SharedServerSuite) TestWorkflow_Execute_SimpleSuccess() {
s.ContainsOnSameLine(out, "WorkflowId", "my-id1")
s.Equal([]any{"val1", "val2"}, s.Worker().DevWorkflowLastInput())
// Confirm we have some events
s.ContainsOnSameLine(out, "1", "WorkflowExecutionStarted")
s.ContainsOnSameLine(out, "2", "WorkflowTaskScheduled")
s.ContainsOnSameLine(out, "1", "WorkflowExecutionStarted", "DevWorkflow")
s.ContainsOnSameLine(out, "2", "WorkflowTaskScheduled", s.Worker().Options.TaskQueue)
s.ContainsOnSameLine(out, "3", "WorkflowTaskStarted")
// Confirm results
s.Contains(out, "RunTime")
Expand Down