-
Notifications
You must be signed in to change notification settings - Fork 787
/
options.go
109 lines (93 loc) · 3.95 KB
/
options.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
// Copyright (c) 2017 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 archiver
import (
"context"
"errors"
"go.uber.org/cadence/activity"
"github.com/uber/cadence/common/dynamicconfig"
)
type (
// ArchiveOption is used to provide options for adding features to
// the Archive method of History/Visibility Archiver
ArchiveOption func(featureCatalog *ArchiveFeatureCatalog)
// ArchiveFeatureCatalog is a collection features for the Archive method of
// History/Visibility Archiver
ArchiveFeatureCatalog struct {
ProgressManager ProgressManager
NonRetriableError NonRetriableError
ArchiveIncompleteHistory dynamicconfig.BoolPropertyFn
}
// NonRetriableError returns an error indicating archiver has encountered an non-retriable error
NonRetriableError func() error
// ProgressManager is used to record and load archive progress
ProgressManager interface {
RecordProgress(ctx context.Context, progress interface{}) error
LoadProgress(ctx context.Context, valuePtr interface{}) error
HasProgress(ctx context.Context) bool
}
)
// GetFeatureCatalog applies all the ArchiveOptions to the catalog and returns the catalog.
// It should be called inside the Archive method.
func GetFeatureCatalog(opts ...ArchiveOption) *ArchiveFeatureCatalog {
catalog := &ArchiveFeatureCatalog{
ArchiveIncompleteHistory: dynamicconfig.GetBoolPropertyFn(false),
}
for _, opt := range opts {
opt(catalog)
}
return catalog
}
// GetHeartbeatArchiveOption returns an ArchiveOption for enabling heartbeating.
// It should be used when the Archive method is invoked inside an activity.
func GetHeartbeatArchiveOption() ArchiveOption {
return func(catalog *ArchiveFeatureCatalog) {
catalog.ProgressManager = &heartbeatProgressManager{}
}
}
type heartbeatProgressManager struct{}
func (h *heartbeatProgressManager) RecordProgress(ctx context.Context, progress interface{}) error {
activity.RecordHeartbeat(ctx, progress)
return nil
}
func (h *heartbeatProgressManager) LoadProgress(ctx context.Context, valuePtr interface{}) error {
if !h.HasProgress(ctx) {
return errors.New("no progress information in the context")
}
return activity.GetHeartbeatDetails(ctx, valuePtr)
}
func (h *heartbeatProgressManager) HasProgress(ctx context.Context) bool {
return activity.HasHeartbeatDetails(ctx)
}
// GetNonRetriableErrorOption returns an ArchiveOption so that archiver knows what should
// be returned when an non-retryable error is encountered.
func GetNonRetriableErrorOption(nonRetryableErr error) ArchiveOption {
return func(catalog *ArchiveFeatureCatalog) {
catalog.NonRetriableError = func() error {
return nonRetryableErr
}
}
}
// GetArchivingIncompleteHistoryOption returns an ArchiveOption so that archiver would archive incomplete history
func GetArchivingIncompleteHistoryOption(allow dynamicconfig.BoolPropertyFn) ArchiveOption {
return func(catalog *ArchiveFeatureCatalog) {
catalog.ArchiveIncompleteHistory = allow
}
}