Skip to content
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

Use a prefix for scheduler workflow ids #3201

Merged
merged 1 commit into from
Aug 10, 2022
Merged

Use a prefix for scheduler workflow ids #3201

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
37 changes: 25 additions & 12 deletions service/frontend/workflowHandler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (
"context"
"encoding/binary"
"fmt"
"strings"
"sync/atomic"
"time"
"unicode/utf8"
Expand Down Expand Up @@ -3016,8 +3017,9 @@ func (wh *WorkflowHandler) CreateSchedule(ctx context.Context, request *workflow
return nil, errSchedulesNotAllowed
}

// a schedule id is a workflow id so validate it the same way
if err := wh.validateWorkflowID(request.ScheduleId); err != nil {
workflowID := scheduler.WorkflowIDPrefix + request.ScheduleId

if err := wh.validateWorkflowID(workflowID); err != nil {
return nil, err
}

Expand Down Expand Up @@ -3107,7 +3109,7 @@ func (wh *WorkflowHandler) CreateSchedule(ctx context.Context, request *workflow
// Create StartWorkflowExecutionRequest
startReq := &workflowservice.StartWorkflowExecutionRequest{
Namespace: request.Namespace,
WorkflowId: request.ScheduleId,
WorkflowId: workflowID,
WorkflowType: &commonpb.WorkflowType{Name: scheduler.WorkflowType},
TaskQueue: &taskqueuepb.TaskQueue{Name: workercommon.PerNSWorkerTaskQueue},
Input: inputPayload,
Expand Down Expand Up @@ -3154,7 +3156,8 @@ func (wh *WorkflowHandler) DescribeSchedule(ctx context.Context, request *workfl
return nil, err
}

execution := &commonpb.WorkflowExecution{WorkflowId: request.ScheduleId}
workflowID := scheduler.WorkflowIDPrefix + request.ScheduleId
execution := &commonpb.WorkflowExecution{WorkflowId: workflowID}

// first describe to get memo and search attributes
describeResponse, err := wh.historyClient.DescribeWorkflowExecution(ctx, &historyservice.DescribeWorkflowExecutionRequest{
Expand Down Expand Up @@ -3319,6 +3322,8 @@ func (wh *WorkflowHandler) UpdateSchedule(ctx context.Context, request *workflow
return nil, errRequestIDTooLong
}

workflowID := scheduler.WorkflowIDPrefix + request.ScheduleId

namespaceID, err := wh.namespaceRegistry.GetNamespaceID(namespace.Name(request.GetNamespace()))
if err != nil {
return nil, err
Expand All @@ -3342,7 +3347,7 @@ func (wh *WorkflowHandler) UpdateSchedule(ctx context.Context, request *workflow
sizeLimitWarn,
sizeLimitError,
namespaceID.String(),
request.GetScheduleId(),
workflowID,
"", // don't have runid yet
wh.metricsScope(ctx).Tagged(metrics.CommandTypeTag(enumspb.COMMAND_TYPE_UNSPECIFIED.String())),
wh.throttledLogger,
Expand All @@ -3355,7 +3360,7 @@ func (wh *WorkflowHandler) UpdateSchedule(ctx context.Context, request *workflow
NamespaceId: namespaceID.String(),
SignalRequest: &workflowservice.SignalWorkflowExecutionRequest{
Namespace: request.Namespace,
WorkflowExecution: &commonpb.WorkflowExecution{WorkflowId: request.ScheduleId},
WorkflowExecution: &commonpb.WorkflowExecution{WorkflowId: workflowID},
SignalName: scheduler.SignalNameUpdate,
Input: inputPayloads,
Identity: request.Identity,
Expand Down Expand Up @@ -3393,6 +3398,8 @@ func (wh *WorkflowHandler) PatchSchedule(ctx context.Context, request *workflows
return nil, errRequestIDTooLong
}

workflowID := scheduler.WorkflowIDPrefix + request.ScheduleId

namespaceID, err := wh.namespaceRegistry.GetNamespaceID(namespace.Name(request.GetNamespace()))
if err != nil {
return nil, err
Expand All @@ -3415,7 +3422,7 @@ func (wh *WorkflowHandler) PatchSchedule(ctx context.Context, request *workflows
sizeLimitWarn,
sizeLimitError,
namespaceID.String(),
request.GetScheduleId(),
workflowID,
"", // don't have runid yet
wh.metricsScope(ctx).Tagged(metrics.CommandTypeTag(enumspb.COMMAND_TYPE_UNSPECIFIED.String())),
wh.throttledLogger,
Expand All @@ -3428,7 +3435,7 @@ func (wh *WorkflowHandler) PatchSchedule(ctx context.Context, request *workflows
NamespaceId: namespaceID.String(),
SignalRequest: &workflowservice.SignalWorkflowExecutionRequest{
Namespace: request.Namespace,
WorkflowExecution: &commonpb.WorkflowExecution{WorkflowId: request.ScheduleId},
WorkflowExecution: &commonpb.WorkflowExecution{WorkflowId: workflowID},
SignalName: scheduler.SignalNamePatch,
Input: inputPayloads,
Identity: request.Identity,
Expand Down Expand Up @@ -3462,6 +3469,8 @@ func (wh *WorkflowHandler) ListScheduleMatchingTimes(ctx context.Context, reques
return nil, errSchedulesNotAllowed
}

workflowID := scheduler.WorkflowIDPrefix + request.ScheduleId

namespaceID, err := wh.namespaceRegistry.GetNamespaceID(namespace.Name(request.GetNamespace()))
if err != nil {
return nil, err
Expand All @@ -3479,7 +3488,7 @@ func (wh *WorkflowHandler) ListScheduleMatchingTimes(ctx context.Context, reques
sizeLimitWarn,
sizeLimitError,
namespaceID.String(),
request.ScheduleId,
workflowID,
"",
wh.metricsScope(ctx).Tagged(metrics.CommandTypeTag(enumspb.COMMAND_TYPE_UNSPECIFIED.String())),
wh.throttledLogger,
Expand All @@ -3491,7 +3500,7 @@ func (wh *WorkflowHandler) ListScheduleMatchingTimes(ctx context.Context, reques
NamespaceId: namespaceID.String(),
Request: &workflowservice.QueryWorkflowRequest{
Namespace: request.Namespace,
Execution: &commonpb.WorkflowExecution{WorkflowId: request.ScheduleId},
Execution: &commonpb.WorkflowExecution{WorkflowId: workflowID},
Query: &querypb.WorkflowQuery{
QueryType: scheduler.QueryNameListMatchingTimes,
QueryArgs: queryPayload,
Expand Down Expand Up @@ -3532,6 +3541,8 @@ func (wh *WorkflowHandler) DeleteSchedule(ctx context.Context, request *workflow
return nil, errSchedulesNotAllowed
}

workflowID := scheduler.WorkflowIDPrefix + request.ScheduleId

namespaceID, err := wh.namespaceRegistry.GetNamespaceID(namespace.Name(request.GetNamespace()))
if err != nil {
return nil, err
Expand All @@ -3541,7 +3552,7 @@ func (wh *WorkflowHandler) DeleteSchedule(ctx context.Context, request *workflow
NamespaceId: namespaceID.String(),
TerminateRequest: &workflowservice.TerminateWorkflowExecutionRequest{
Namespace: request.Namespace,
WorkflowExecution: &commonpb.WorkflowExecution{WorkflowId: request.ScheduleId},
WorkflowExecution: &commonpb.WorkflowExecution{WorkflowId: workflowID},
Reason: "terminated by DeleteSchedule",
Identity: request.Identity,
},
Expand Down Expand Up @@ -3612,8 +3623,10 @@ func (wh *WorkflowHandler) ListSchedules(ctx context.Context, request *workflows
info := wh.decodeScheduleListInfo(searchAttributes)
searchAttributes = wh.cleanScheduleSearchAttributes(searchAttributes)
memo := wh.cleanScheduleMemo(ex.GetMemo())
workflowID := ex.GetExecution().GetWorkflowId()
scheduleID := strings.TrimPrefix(workflowID, scheduler.WorkflowIDPrefix)
schedules[i] = &schedpb.ScheduleListEntry{
ScheduleId: ex.GetExecution().GetWorkflowId(),
ScheduleId: scheduleID,
Memo: memo,
SearchAttributes: searchAttributes,
Info: info,
Expand Down
3 changes: 3 additions & 0 deletions service/worker/scheduler/workflow.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ import (
)

const (
// Schedules are implemented by a workflow whose ID is this string plus the schedule ID.
WorkflowIDPrefix = "temporal-sys-scheduler:"

// This is an example of a timestamp that's appended to the workflow
// id, used for validation in the frontend.
AppendedTimestampForValidation = "-2009-11-10T23:00:00Z"
Expand Down