-
Notifications
You must be signed in to change notification settings - Fork 755
/
util.go
686 lines (587 loc) · 23.3 KB
/
util.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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 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 common
import (
"context"
"errors"
"fmt"
"math/rand"
"sort"
"strings"
"sync"
"time"
"github.com/dgryski/go-farm"
"github.com/gogo/protobuf/proto"
commonpb "go.temporal.io/api/common/v1"
enumspb "go.temporal.io/api/enums/v1"
historypb "go.temporal.io/api/history/v1"
"go.temporal.io/api/serviceerror"
"go.temporal.io/api/workflowservice/v1"
"go.temporal.io/server/common/number"
workflowspb "go.temporal.io/server/api/workflow/v1"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/api/historyservice/v1"
"go.temporal.io/server/api/matchingservice/v1"
"go.temporal.io/server/common/backoff"
"go.temporal.io/server/common/dynamicconfig"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/log/tag"
"go.temporal.io/server/common/primitives/timestamp"
serviceerrors "go.temporal.io/server/common/serviceerror"
)
const (
retryPersistenceOperationInitialInterval = 50 * time.Millisecond
retryPersistenceOperationMaxInterval = 10 * time.Second
retryPersistenceOperationExpirationInterval = 30 * time.Second
historyServiceOperationInitialInterval = 50 * time.Millisecond
historyServiceOperationMaxInterval = 10 * time.Second
historyServiceOperationExpirationInterval = 30 * time.Second
matchingServiceOperationInitialInterval = 1000 * time.Millisecond
matchingServiceOperationMaxInterval = 10 * time.Second
matchingServiceOperationExpirationInterval = 30 * time.Second
frontendServiceOperationInitialInterval = 200 * time.Millisecond
frontendServiceOperationMaxInterval = 5 * time.Second
frontendServiceOperationExpirationInterval = 15 * time.Second
adminServiceOperationInitialInterval = 200 * time.Millisecond
adminServiceOperationMaxInterval = 5 * time.Second
adminServiceOperationExpirationInterval = 15 * time.Second
retryTaskProcessingInitialInterval = 50 * time.Millisecond
retryTaskProcessingMaxInterval = 100 * time.Millisecond
retryTaskProcessingMaxAttempts = 3
replicationServiceBusyInitialInterval = 2 * time.Second
replicationServiceBusyMaxInterval = 10 * time.Second
replicationServiceBusyExpirationInterval = 30 * time.Second
defaultInitialInterval = time.Second
defaultMaximumIntervalCoefficient = 100.0
defaultBackoffCoefficient = 2.0
defaultMaximumAttempts = 0
initialIntervalInSecondsConfigKey = "InitialIntervalInSeconds"
maximumIntervalCoefficientConfigKey = "MaximumIntervalCoefficient"
backoffCoefficientConfigKey = "BackoffCoefficient"
maximumAttemptsConfigKey = "MaximumAttempts"
contextExpireThreshold = 10 * time.Millisecond
// FailureReasonCompleteResultExceedsLimit is failureReason for complete result exceeds limit
FailureReasonCompleteResultExceedsLimit = "Complete result exceeds size limit."
// FailureReasonFailureDetailsExceedsLimit is failureReason for failure details exceeds limit
FailureReasonFailureExceedsLimit = "Failure exceeds size limit."
// FailureReasonCancelDetailsExceedsLimit is failureReason for cancel details exceeds limit
FailureReasonCancelDetailsExceedsLimit = "Cancel details exceed size limit."
// FailureReasonHeartbeatExceedsLimit is failureReason for heartbeat exceeds limit
FailureReasonHeartbeatExceedsLimit = "Heartbeat details exceed size limit."
// FailureReasonSizeExceedsLimit is reason to fail workflow when history size or count exceed limit
FailureReasonSizeExceedsLimit = "Workflow history size / count exceeds limit."
// FailureReasonTransactionSizeExceedsLimit is the failureReason for when transaction cannot be committed because it exceeds size limit
FailureReasonTransactionSizeExceedsLimit = "Transaction size exceeds limit."
)
var (
// ErrBlobSizeExceedsLimit is error for event blob size exceeds limit
ErrBlobSizeExceedsLimit = serviceerror.NewInvalidArgument("Blob data size exceeds limit.")
// ErrContextTimeoutTooShort is error for setting a very short context timeout when calling a long poll API
ErrContextTimeoutTooShort = serviceerror.NewInvalidArgument("Context timeout is too short.")
// ErrContextTimeoutNotSet is error for not setting a context timeout when calling a long poll API
ErrContextTimeoutNotSet = serviceerror.NewInvalidArgument("Context timeout is not set.")
)
// AwaitWaitGroup calls Wait on the given wait
// Returns true if the Wait() call succeeded before the timeout
// Returns false if the Wait() did not return before the timeout
func AwaitWaitGroup(wg *sync.WaitGroup, timeout time.Duration) bool {
doneC := make(chan struct{})
go func() {
wg.Wait()
close(doneC)
}()
select {
case <-doneC:
return true
case <-time.After(timeout):
return false
}
}
// CreatePersistanceRetryPolicy creates a retry policy for persistence layer operations
func CreatePersistanceRetryPolicy() backoff.RetryPolicy {
policy := backoff.NewExponentialRetryPolicy(retryPersistenceOperationInitialInterval)
policy.SetMaximumInterval(retryPersistenceOperationMaxInterval)
policy.SetExpirationInterval(retryPersistenceOperationExpirationInterval)
return policy
}
// CreateHistoryServiceRetryPolicy creates a retry policy for calls to history service
func CreateHistoryServiceRetryPolicy() backoff.RetryPolicy {
policy := backoff.NewExponentialRetryPolicy(historyServiceOperationInitialInterval)
policy.SetMaximumInterval(historyServiceOperationMaxInterval)
policy.SetExpirationInterval(historyServiceOperationExpirationInterval)
return policy
}
// CreateMatchingServiceRetryPolicy creates a retry policy for calls to matching service
func CreateMatchingServiceRetryPolicy() backoff.RetryPolicy {
policy := backoff.NewExponentialRetryPolicy(matchingServiceOperationInitialInterval)
policy.SetMaximumInterval(matchingServiceOperationMaxInterval)
policy.SetExpirationInterval(matchingServiceOperationExpirationInterval)
return policy
}
// CreateFrontendServiceRetryPolicy creates a retry policy for calls to frontend service
func CreateFrontendServiceRetryPolicy() backoff.RetryPolicy {
policy := backoff.NewExponentialRetryPolicy(frontendServiceOperationInitialInterval)
policy.SetMaximumInterval(frontendServiceOperationMaxInterval)
policy.SetExpirationInterval(frontendServiceOperationExpirationInterval)
return policy
}
// CreateAdminServiceRetryPolicy creates a retry policy for calls to matching service
func CreateAdminServiceRetryPolicy() backoff.RetryPolicy {
policy := backoff.NewExponentialRetryPolicy(adminServiceOperationInitialInterval)
policy.SetMaximumInterval(adminServiceOperationMaxInterval)
policy.SetExpirationInterval(adminServiceOperationExpirationInterval)
return policy
}
// CreateTaskProcessingRetryPolicy creates a retry policy for task processing
func CreateTaskProcessingRetryPolicy() backoff.RetryPolicy {
policy := backoff.NewExponentialRetryPolicy(retryTaskProcessingInitialInterval)
policy.SetMaximumInterval(retryTaskProcessingMaxInterval)
policy.SetMaximumAttempts(retryTaskProcessingMaxAttempts)
return policy
}
// CreateReplicationServiceBusyRetryPolicy creates a retry policy to handle replication service busy
func CreateReplicationServiceBusyRetryPolicy() backoff.RetryPolicy {
policy := backoff.NewExponentialRetryPolicy(replicationServiceBusyInitialInterval)
policy.SetMaximumInterval(replicationServiceBusyMaxInterval)
policy.SetExpirationInterval(replicationServiceBusyExpirationInterval)
return policy
}
// IsPersistenceTransientError checks if the error is a transient persistence error
func IsPersistenceTransientError(err error) bool {
switch err.(type) {
case *serviceerror.Internal,
*serviceerror.ResourceExhausted:
return true
}
return false
}
// IsServiceTransientError checks if the error is a retryable error.
func IsServiceTransientError(err error) bool {
return !IsServiceNonRetryableError(err)
}
// IsServiceNonRetryableError checks if the error is a non retryable error.
func IsServiceNonRetryableError(err error) bool {
switch err.(type) {
case *serviceerror.NotFound,
*serviceerror.InvalidArgument,
*serviceerror.NamespaceNotActive,
*serviceerror.WorkflowExecutionAlreadyStarted:
return true
}
if IsContextDeadlineExceededErr(err) {
return true
}
return false
}
// IsContextDeadlineExceededErr checks if the error is context.DeadlineExceeded or serviceerror.DeadlineExceeded error
func IsContextDeadlineExceededErr(err error) bool {
var deadlineExceededSvcErr *serviceerror.DeadlineExceeded
return errors.Is(err, context.DeadlineExceeded) ||
errors.As(err, &deadlineExceededSvcErr)
}
// IsContextCanceledErr checks if the error is context.Canceled or serviceerror.Canceled error
func IsContextCanceledErr(err error) bool {
var canceledSvcErr *serviceerror.Canceled
return errors.Is(err, context.Canceled) ||
errors.As(err, &canceledSvcErr)
}
// IsWhitelistServiceTransientError checks if the error is a transient error.
func IsWhitelistServiceTransientError(err error) bool {
switch err.(type) {
case *serviceerror.Internal,
*serviceerror.ResourceExhausted,
*serviceerrors.ShardOwnershipLost,
*serviceerror.Unavailable:
return true
}
return false
}
// IsResourceExhausted checks if the error is a service busy error.
func IsResourceExhausted(err error) bool {
switch err.(type) {
case *serviceerror.ResourceExhausted:
return true
}
return false
}
// WorkflowIDToHistoryShard is used to map namespaceID-workflowID pair to a shardID
func WorkflowIDToHistoryShard(
namespaceID string,
workflowID string,
numberOfShards int32,
) int32 {
idBytes := []byte(namespaceID + "_" + workflowID)
hash := farm.Fingerprint32(idBytes)
return int32(hash%uint32(numberOfShards)) + 1 // ShardID starts with 1
}
// PrettyPrintHistory prints history in human readable format
func PrettyPrintHistory(history *historypb.History, logger log.Logger) {
fmt.Println("******************************************")
fmt.Println("History", proto.MarshalTextString(history))
fmt.Println("******************************************")
}
// IsValidContext checks that the thrift context is not expired on cancelled.
// Returns nil if the context is still valid. Otherwise, returns the result of
// ctx.Err()
func IsValidContext(ctx context.Context) error {
ch := ctx.Done()
if ch != nil {
select {
case <-ch:
return ctx.Err()
default:
return nil
}
}
deadline, ok := ctx.Deadline()
if ok && time.Until(deadline) < contextExpireThreshold {
return context.DeadlineExceeded
}
return nil
}
// GenerateRandomString is used for generate test string
func GenerateRandomString(n int) string {
rand.Seed(time.Now().UnixNano())
letterRunes := []rune("random")
b := make([]rune, n)
for i := range b {
b[i] = letterRunes[rand.Intn(len(letterRunes))]
}
return string(b)
}
// CreateMatchingPollWorkflowTaskQueueResponse create response for matching's PollWorkflowTaskQueue
func CreateMatchingPollWorkflowTaskQueueResponse(historyResponse *historyservice.RecordWorkflowTaskStartedResponse, workflowExecution *commonpb.WorkflowExecution, token []byte) *matchingservice.PollWorkflowTaskQueueResponse {
matchingResp := &matchingservice.PollWorkflowTaskQueueResponse{
TaskToken: token,
WorkflowExecution: workflowExecution,
WorkflowType: historyResponse.WorkflowType,
PreviousStartedEventId: historyResponse.PreviousStartedEventId,
StartedEventId: historyResponse.StartedEventId,
Attempt: historyResponse.GetAttempt(),
NextEventId: historyResponse.NextEventId,
StickyExecutionEnabled: historyResponse.StickyExecutionEnabled,
WorkflowTaskInfo: historyResponse.WorkflowTaskInfo,
WorkflowExecutionTaskQueue: historyResponse.WorkflowExecutionTaskQueue,
BranchToken: historyResponse.BranchToken,
ScheduledTime: historyResponse.ScheduledTime,
StartedTime: historyResponse.StartedTime,
Queries: historyResponse.Queries,
}
return matchingResp
}
// MinInt64 returns the smaller of two given int64
func MinInt64(a, b int64) int64 {
if a < b {
return a
}
return b
}
// MinTime returns the smaller of two given time.Time
func MinTime(a, b time.Time) time.Time {
if a.Before(b) {
return a
}
return b
}
// MaxInt64 returns the greater of two given int64
func MaxInt64(a, b int64) int64 {
if a > b {
return a
}
return b
}
// MinTime returns the smaller of two given time.Time
func MaxTime(a, b time.Time) time.Time {
if a.After(b) {
return a
}
return b
}
// MinInt32 return smaller one of two inputs int32
func MinInt32(a, b int32) int32 {
if a < b {
return a
}
return b
}
// MinInt returns the smaller of two given integers
func MinInt(a, b int) int {
if a < b {
return a
}
return b
}
// MaxInt returns the greater one of two given integers
func MaxInt(a, b int) int {
if a > b {
return a
}
return b
}
// MinDuration returns the smaller of two given time duration
func MinDuration(a, b time.Duration) time.Duration {
if a < b {
return a
}
return b
}
// MaxDuration returns the greater of two given time durations
func MaxDuration(a, b time.Duration) time.Duration {
if a > b {
return a
}
return b
}
// SortInt64Slice sorts the given int64 slice.
// Sort is not guaranteed to be stable.
func SortInt64Slice(slice []int64) {
sort.Slice(slice, func(i int, j int) bool {
return slice[i] < slice[j]
})
}
// EnsureRetryPolicyDefaults ensures the policy subfields, if not explicitly set, are set to the specified defaults
func EnsureRetryPolicyDefaults(originalPolicy *commonpb.RetryPolicy, defaultSettings DefaultRetrySettings) {
if originalPolicy.GetMaximumAttempts() == 0 {
originalPolicy.MaximumAttempts = defaultSettings.MaximumAttempts
}
if timestamp.DurationValue(originalPolicy.GetInitialInterval()) == 0 {
originalPolicy.InitialInterval = timestamp.DurationPtr(defaultSettings.InitialInterval)
}
if timestamp.DurationValue(originalPolicy.GetMaximumInterval()) == 0 {
originalPolicy.MaximumInterval = timestamp.DurationPtr(time.Duration(defaultSettings.MaximumIntervalCoefficient) * timestamp.DurationValue(originalPolicy.GetInitialInterval()))
}
if originalPolicy.GetBackoffCoefficient() == 0 {
originalPolicy.BackoffCoefficient = defaultSettings.BackoffCoefficient
}
}
// ValidateRetryPolicy validates a retry policy
func ValidateRetryPolicy(policy *commonpb.RetryPolicy) error {
if policy == nil {
// nil policy is valid which means no retry
return nil
}
if policy.GetMaximumAttempts() == 1 {
// One maximum attempt effectively disable retries. Validating the
// rest of the arguments is pointless
return nil
}
if timestamp.DurationValue(policy.GetInitialInterval()) < 0 {
return serviceerror.NewInvalidArgument("InitialInterval cannot be negative on retry policy.")
}
if policy.GetBackoffCoefficient() < 1 {
return serviceerror.NewInvalidArgument("BackoffCoefficient cannot be less than 1 on retry policy.")
}
if timestamp.DurationValue(policy.GetMaximumInterval()) < 0 {
return serviceerror.NewInvalidArgument("MaximumInterval cannot be negative on retry policy.")
}
if timestamp.DurationValue(policy.GetMaximumInterval()) > 0 && timestamp.DurationValue(policy.GetMaximumInterval()) < timestamp.DurationValue(policy.GetInitialInterval()) {
return serviceerror.NewInvalidArgument("MaximumInterval cannot be less than InitialInterval on retry policy.")
}
if policy.GetMaximumAttempts() < 0 {
return serviceerror.NewInvalidArgument("MaximumAttempts cannot be negative on retry policy.")
}
return nil
}
func GetDefaultRetryPolicyConfigOptions() map[string]interface{} {
return map[string]interface{}{
initialIntervalInSecondsConfigKey: int(defaultInitialInterval.Seconds()),
maximumIntervalCoefficientConfigKey: defaultMaximumIntervalCoefficient,
backoffCoefficientConfigKey: defaultBackoffCoefficient,
maximumAttemptsConfigKey: defaultMaximumAttempts,
}
}
func FromConfigToDefaultRetrySettings(options map[string]interface{}) DefaultRetrySettings {
defaultSettings := DefaultRetrySettings{
InitialInterval: defaultInitialInterval,
MaximumIntervalCoefficient: defaultMaximumIntervalCoefficient,
BackoffCoefficient: defaultBackoffCoefficient,
MaximumAttempts: defaultMaximumAttempts,
}
if seconds, ok := options[initialIntervalInSecondsConfigKey]; ok {
defaultSettings.InitialInterval = time.Duration(
number.NewNumber(
seconds,
).GetIntOrDefault(int(defaultInitialInterval.Nanoseconds())),
) * time.Second
}
if coefficient, ok := options[maximumIntervalCoefficientConfigKey]; ok {
defaultSettings.MaximumIntervalCoefficient = number.NewNumber(
coefficient,
).GetFloatOrDefault(defaultMaximumIntervalCoefficient)
}
if coefficient, ok := options[backoffCoefficientConfigKey]; ok {
defaultSettings.BackoffCoefficient = number.NewNumber(
coefficient,
).GetFloatOrDefault(defaultBackoffCoefficient)
}
if attempts, ok := options[maximumAttemptsConfigKey]; ok {
defaultSettings.MaximumAttempts = int32(number.NewNumber(
attempts,
).GetIntOrDefault(defaultMaximumAttempts))
}
return defaultSettings
}
// CreateHistoryStartWorkflowRequest create a start workflow request for history
func CreateHistoryStartWorkflowRequest(
namespaceID string,
startRequest *workflowservice.StartWorkflowExecutionRequest,
parentExecutionInfo *workflowspb.ParentExecutionInfo,
now time.Time,
) *historyservice.StartWorkflowExecutionRequest {
histRequest := &historyservice.StartWorkflowExecutionRequest{
NamespaceId: namespaceID,
StartRequest: startRequest,
ContinueAsNewInitiator: enumspb.CONTINUE_AS_NEW_INITIATOR_UNSPECIFIED,
Attempt: 1,
ParentExecutionInfo: parentExecutionInfo,
FirstWorkflowTaskBackoff: backoff.GetBackoffForNextScheduleNonNegative(startRequest.GetCronSchedule(), now, now),
}
if timestamp.DurationValue(startRequest.GetWorkflowExecutionTimeout()) > 0 {
deadline := now.Add(timestamp.DurationValue(startRequest.GetWorkflowExecutionTimeout()))
histRequest.WorkflowExecutionExpirationTime = timestamp.TimePtr(deadline.Round(time.Millisecond))
}
if len(startRequest.CronSchedule) != 0 {
histRequest.ContinueAsNewInitiator = enumspb.CONTINUE_AS_NEW_INITIATOR_CRON_SCHEDULE
}
return histRequest
}
// CheckEventBlobSizeLimit checks if a blob data exceeds limits. It logs a warning if it exceeds warnLimit,
// and return ErrBlobSizeExceedsLimit if it exceeds errorLimit.
func CheckEventBlobSizeLimit(
actualSize int,
warnLimit int,
errorLimit int,
namespaceID string,
workflowID string,
runID string,
scope metrics.Scope,
logger log.Logger,
blobSizeViolationOperationTag tag.ZapTag,
) error {
scope.RecordDistribution(metrics.EventBlobSize, actualSize)
if actualSize > warnLimit {
if logger != nil {
logger.Warn("Blob size exceeds limit.",
tag.WorkflowNamespaceID(namespaceID),
tag.WorkflowID(workflowID),
tag.WorkflowRunID(runID),
tag.WorkflowSize(int64(actualSize)),
blobSizeViolationOperationTag)
}
if actualSize > errorLimit {
return ErrBlobSizeExceedsLimit
}
}
return nil
}
// ValidateLongPollContextTimeout check if the context timeout for a long poll handler is too short or below a normal value.
// If the timeout is not set or too short, it logs an error, and return ErrContextTimeoutNotSet or ErrContextTimeoutTooShort
// accordingly. If the timeout is only below a normal value, it just logs an info and return nil.
func ValidateLongPollContextTimeout(
ctx context.Context,
handlerName string,
logger log.Logger,
) error {
deadline, err := ValidateLongPollContextTimeoutIsSet(ctx, handlerName, logger)
if err != nil {
return err
}
timeout := time.Until(deadline)
if timeout < MinLongPollTimeout {
err := ErrContextTimeoutTooShort
logger.Error("Context timeout is too short for long poll API.",
tag.WorkflowHandlerName(handlerName), tag.Error(err), tag.WorkflowPollContextTimeout(timeout))
return err
}
if timeout < CriticalLongPollTimeout {
logger.Warn("Context timeout is lower than critical value for long poll API.",
tag.WorkflowHandlerName(handlerName), tag.WorkflowPollContextTimeout(timeout))
}
return nil
}
// ValidateLongPollContextTimeoutIsSet checks if the context timeout is set for long poll requests.
func ValidateLongPollContextTimeoutIsSet(
ctx context.Context,
handlerName string,
logger log.Logger,
) (time.Time, error) {
deadline, ok := ctx.Deadline()
if !ok {
err := ErrContextTimeoutNotSet
logger.Error("Context timeout not set for long poll API.",
tag.WorkflowHandlerName(handlerName), tag.Error(err))
return deadline, err
}
return deadline, nil
}
// IsJustOrderByClause return true is query start with order by
func IsJustOrderByClause(clause string) bool {
whereClause := strings.TrimSpace(clause)
whereClause = strings.ToLower(whereClause)
return strings.HasPrefix(whereClause, "order by")
}
// GetDefaultAdvancedVisibilityWritingMode get default advancedVisibilityWritingMode based on
// whether related config exists in static config file.
func GetDefaultAdvancedVisibilityWritingMode(isAdvancedVisConfigExist bool) string {
if isAdvancedVisConfigExist {
return AdvancedVisibilityWritingModeOn
}
return AdvancedVisibilityWritingModeOff
}
func GetPayloadsMapSize(data map[string]*commonpb.Payloads) int {
size := 0
for key, payloads := range data {
size += len(key)
size += payloads.Size()
}
return size
}
// OverrideWorkflowRunTimeout override the run timeout according to execution timeout
func OverrideWorkflowRunTimeout(
workflowRunTimeout time.Duration,
workflowExecutionTimeout time.Duration,
) time.Duration {
if workflowExecutionTimeout == 0 {
return workflowRunTimeout
} else if workflowRunTimeout == 0 {
return workflowExecutionTimeout
}
return timestamp.MinDuration(workflowRunTimeout, workflowExecutionTimeout)
}
// OverrideWorkflowTaskTimeout override the workflow task timeout according to default timeout or max timeout
func OverrideWorkflowTaskTimeout(
namespace string,
taskStartToCloseTimeout time.Duration,
workflowRunTimeout time.Duration,
getDefaultTimeoutFunc dynamicconfig.DurationPropertyFnWithNamespaceFilter,
) time.Duration {
if taskStartToCloseTimeout == 0 {
taskStartToCloseTimeout = getDefaultTimeoutFunc(namespace)
}
taskStartToCloseTimeout = timestamp.MinDuration(taskStartToCloseTimeout, MaxWorkflowTaskStartToCloseTimeout)
if workflowRunTimeout == 0 {
return taskStartToCloseTimeout
}
return timestamp.MinDuration(taskStartToCloseTimeout, workflowRunTimeout)
}