Skip to content

Commit

Permalink
Refactor frontend api handler (cadence-workflow#6450)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Shaddoll
Shaddoll authored Oct 30, 2024
1 parent 32f2b52 commit 115a0da
Show file tree
Hide file tree
Showing 8 changed files with 1,436 additions and 162 deletions.
165 changes: 3 additions & 162 deletions service/frontend/api/handler.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ type (
throttleRetry *backoff.ThrottleRetry
producerManager ProducerManager
thriftrwEncoder codec.BinaryEncoder
requestValidator RequestValidator
}

getHistoryContinuationToken struct {
Expand Down Expand Up @@ -143,7 +144,8 @@ func NewWorkflowHandler(
resource.GetLogger(),
resource.GetMetricsClient(),
),
thriftrwEncoder: codec.NewThriftRWEncoder(),
thriftrwEncoder: codec.NewThriftRWEncoder(),
requestValidator: NewRequestValidator(resource.GetLogger(), resource.GetMetricsClient(), config),
}
}

Expand Down Expand Up @@ -3237,45 +3239,6 @@ func (wh *WorkflowHandler) GetSearchAttributes(ctx context.Context) (resp *types
return resp, nil
}

// ResetStickyTaskList reset the volatile information in mutable state of a given workflow.
func (wh *WorkflowHandler) ResetStickyTaskList(
ctx context.Context,
resetRequest *types.ResetStickyTaskListRequest,
) (resp *types.ResetStickyTaskListResponse, retError error) {
if wh.isShuttingDown() {
return nil, validate.ErrShuttingDown
}

if resetRequest == nil {
return nil, validate.ErrRequestNotSet
}

domainName := resetRequest.GetDomain()
wfExecution := resetRequest.GetExecution()

if domainName == "" {
return nil, validate.ErrDomainNotSet
}

if err := validate.CheckExecution(wfExecution); err != nil {
return nil, err
}

domainID, err := wh.GetDomainCache().GetDomainID(resetRequest.GetDomain())
if err != nil {
return nil, err
}

_, err = wh.GetHistoryClient().ResetStickyTaskList(ctx, &types.HistoryResetStickyTaskListRequest{
DomainUUID: domainID,
Execution: resetRequest.Execution,
})
if err != nil {
return nil, wh.normalizeVersionedErrors(ctx, err)
}
return &types.ResetStickyTaskListResponse{}, nil
}

// QueryWorkflow returns query result for a specified workflow execution
func (wh *WorkflowHandler) QueryWorkflow(
ctx context.Context,
Expand Down Expand Up @@ -3388,128 +3351,6 @@ func (wh *WorkflowHandler) DescribeWorkflowExecution(
return response, nil
}

// DescribeTaskList returns information about the target tasklist, right now this API returns the
// pollers which polled this tasklist in last few minutes. If includeTaskListStatus field is true,
// it will also return status of tasklist's ackManager (readLevel, ackLevel, backlogCountHint and taskIDBlock).
func (wh *WorkflowHandler) DescribeTaskList(
ctx context.Context,
request *types.DescribeTaskListRequest,
) (resp *types.DescribeTaskListResponse, retError error) {
if wh.isShuttingDown() {
return nil, validate.ErrShuttingDown
}

if request == nil {
return nil, validate.ErrRequestNotSet
}

if request.GetDomain() == "" {
return nil, validate.ErrDomainNotSet
}

domainID, err := wh.GetDomainCache().GetDomainID(request.GetDomain())
if err != nil {
return nil, err
}

scope := getMetricsScopeWithDomain(metrics.FrontendDescribeTaskListScope, request, wh.GetMetricsClient()).Tagged(metrics.GetContextTags(ctx)...)
if err := wh.validateTaskList(request.TaskList, scope, request.GetDomain()); err != nil {
return nil, err
}

if request.TaskListType == nil {
return nil, validate.ErrTaskListTypeNotSet
}

response, err := wh.GetMatchingClient().DescribeTaskList(ctx, &types.MatchingDescribeTaskListRequest{
DomainUUID: domainID,
DescRequest: request,
})
if err != nil {
return nil, err
}

return response, nil
}

// ListTaskListPartitions returns all the partition and host for a taskList
func (wh *WorkflowHandler) ListTaskListPartitions(
ctx context.Context,
request *types.ListTaskListPartitionsRequest,
) (resp *types.ListTaskListPartitionsResponse, retError error) {
if wh.isShuttingDown() {
return nil, validate.ErrShuttingDown
}

if request == nil {
return nil, validate.ErrRequestNotSet
}

if request.GetDomain() == "" {
return nil, validate.ErrDomainNotSet
}

scope := getMetricsScopeWithDomain(metrics.FrontendListTaskListPartitionsScope, request, wh.GetMetricsClient()).Tagged(metrics.GetContextTags(ctx)...)
if err := wh.validateTaskList(request.TaskList, scope, request.GetDomain()); err != nil {
return nil, err
}

resp, err := wh.GetMatchingClient().ListTaskListPartitions(ctx, &types.MatchingListTaskListPartitionsRequest{
Domain: request.Domain,
TaskList: request.TaskList,
})
return resp, err
}

// GetTaskListsByDomain returns all the partition and host for a taskList
func (wh *WorkflowHandler) GetTaskListsByDomain(
ctx context.Context,
request *types.GetTaskListsByDomainRequest,
) (resp *types.GetTaskListsByDomainResponse, retError error) {
if wh.isShuttingDown() {
return nil, validate.ErrShuttingDown
}

if request == nil {
return nil, validate.ErrRequestNotSet
}

if request.GetDomain() == "" {
return nil, validate.ErrDomainNotSet
}

resp, err := wh.GetMatchingClient().GetTaskListsByDomain(ctx, &types.GetTaskListsByDomainRequest{
Domain: request.Domain,
})
return resp, err
}

// RefreshWorkflowTasks re-generates the workflow tasks
func (wh *WorkflowHandler) RefreshWorkflowTasks(
ctx context.Context,
request *types.RefreshWorkflowTasksRequest,
) (err error) {
if request == nil {
return validate.ErrRequestNotSet
}
if err := validate.CheckExecution(request.Execution); err != nil {
return err
}
domainEntry, err := wh.GetDomainCache().GetDomain(request.GetDomain())
if err != nil {
return err
}

err = wh.GetHistoryClient().RefreshWorkflowTasks(ctx, &types.HistoryRefreshWorkflowTasksRequest{
DomainUIID: domainEntry.GetInfo().ID,
Request: request,
})
if err != nil {
return err
}
return nil
}

func (wh *WorkflowHandler) getRawHistory(
ctx context.Context,
scope metrics.Scope,
Expand Down
51 changes: 51 additions & 0 deletions service/frontend/api/refresh_workflow_tasks.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// The MIT License (MIT)

// Copyright (c) 2017-2020 Uber Technologies Inc.

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

package api

import (
"context"

"github.com/uber/cadence/common/types"
)

// RefreshWorkflowTasks re-generates the workflow tasks
func (wh *WorkflowHandler) RefreshWorkflowTasks(
ctx context.Context,
request *types.RefreshWorkflowTasksRequest,
) error {
if err := wh.requestValidator.ValidateRefreshWorkflowTasksRequest(ctx, request); err != nil {
return err
}
domainEntry, err := wh.GetDomainCache().GetDomain(request.GetDomain())
if err != nil {
return err
}
err = wh.GetHistoryClient().RefreshWorkflowTasks(ctx, &types.HistoryRefreshWorkflowTasksRequest{
DomainUIID: domainEntry.GetInfo().ID,
Request: request,
})
if err != nil {
return err
}
return nil
}
Loading

0 comments on commit 115a0da

Please sign in to comment.