|
| 1 | +/* |
| 2 | +Copyright 2021 The Dapr Authors |
| 3 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +you may not use this file except in compliance with the License. |
| 5 | +You may obtain a copy of the License at |
| 6 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 7 | +Unless required by applicable law or agreed to in writing, software |
| 8 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 9 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 10 | +See the License for the specific language governing permissions and |
| 11 | +limitations under the License. |
| 12 | +*/ |
| 13 | + |
| 14 | +package client |
| 15 | + |
| 16 | +import ( |
| 17 | + "context" |
| 18 | + "errors" |
| 19 | + "time" |
| 20 | + |
| 21 | + "google.golang.org/protobuf/types/known/anypb" |
| 22 | + "google.golang.org/protobuf/types/known/durationpb" |
| 23 | + |
| 24 | + commonpb "github.com/dapr/dapr/pkg/proto/common/v1" |
| 25 | + runtimepb "github.com/dapr/dapr/pkg/proto/runtime/v1" |
| 26 | + "github.com/dapr/kit/ptr" |
| 27 | +) |
| 28 | + |
| 29 | +type FailurePolicy interface { |
| 30 | + GetPBFailurePolicy() *commonpb.JobFailurePolicy |
| 31 | +} |
| 32 | + |
| 33 | +type JobFailurePolicyConstant struct { |
| 34 | + MaxRetries *uint32 |
| 35 | + Interval *time.Duration |
| 36 | +} |
| 37 | + |
| 38 | +func (f *JobFailurePolicyConstant) GetPBFailurePolicy() *commonpb.JobFailurePolicy { |
| 39 | + constantfp := &commonpb.JobFailurePolicyConstant{} |
| 40 | + if f.MaxRetries != nil { |
| 41 | + constantfp.MaxRetries = f.MaxRetries |
| 42 | + } |
| 43 | + if f.Interval != nil { |
| 44 | + constantfp.Interval = durationpb.New(*f.Interval) |
| 45 | + } |
| 46 | + return &commonpb.JobFailurePolicy{ |
| 47 | + Policy: &commonpb.JobFailurePolicy_Constant{ |
| 48 | + Constant: constantfp, |
| 49 | + }, |
| 50 | + } |
| 51 | +} |
| 52 | + |
| 53 | +type JobFailurePolicyDrop struct{} |
| 54 | + |
| 55 | +func (f *JobFailurePolicyDrop) GetPBFailurePolicy() *commonpb.JobFailurePolicy { |
| 56 | + return &commonpb.JobFailurePolicy{ |
| 57 | + Policy: &commonpb.JobFailurePolicy_Drop{ |
| 58 | + Drop: &commonpb.JobFailurePolicyDrop{}, |
| 59 | + }, |
| 60 | + } |
| 61 | +} |
| 62 | + |
| 63 | +type Job struct { |
| 64 | + Name string |
| 65 | + Schedule *string |
| 66 | + Repeats *uint32 |
| 67 | + DueTime *string |
| 68 | + TTL *string |
| 69 | + Data *anypb.Any |
| 70 | + FailurePolicy FailurePolicy |
| 71 | + Overwrite bool |
| 72 | +} |
| 73 | + |
| 74 | +type JobOption func(*Job) |
| 75 | + |
| 76 | +func NewJob(name string, opts ...JobOption) *Job { |
| 77 | + job := &Job{ |
| 78 | + Name: name, |
| 79 | + } |
| 80 | + for _, opt := range opts { |
| 81 | + opt(job) |
| 82 | + } |
| 83 | + return job |
| 84 | +} |
| 85 | + |
| 86 | +func WithJobSchedule(schedule string) JobOption { |
| 87 | + return func(job *Job) { |
| 88 | + job.Schedule = &schedule |
| 89 | + } |
| 90 | +} |
| 91 | + |
| 92 | +func WithJobRepeats(repeats uint32) JobOption { |
| 93 | + return func(job *Job) { |
| 94 | + job.Repeats = &repeats |
| 95 | + } |
| 96 | +} |
| 97 | + |
| 98 | +func WithJobDueTime(dueTime string) JobOption { |
| 99 | + return func(job *Job) { |
| 100 | + job.DueTime = &dueTime |
| 101 | + } |
| 102 | +} |
| 103 | + |
| 104 | +func WithJobTTL(ttl string) JobOption { |
| 105 | + return func(job *Job) { |
| 106 | + job.TTL = &ttl |
| 107 | + } |
| 108 | +} |
| 109 | + |
| 110 | +func WithJobData(data *anypb.Any) JobOption { |
| 111 | + return func(job *Job) { |
| 112 | + job.Data = data |
| 113 | + } |
| 114 | +} |
| 115 | + |
| 116 | +func WithJobConstantFailurePolicy() JobOption { |
| 117 | + return func(job *Job) { |
| 118 | + job.FailurePolicy = &JobFailurePolicyConstant{} |
| 119 | + } |
| 120 | +} |
| 121 | + |
| 122 | +func WithJobConstantFailurePolicyMaxRetries(maxRetries uint32) JobOption { |
| 123 | + return func(job *Job) { |
| 124 | + if job.FailurePolicy == nil { |
| 125 | + job.FailurePolicy = &JobFailurePolicyConstant{} |
| 126 | + } |
| 127 | + if constantPolicy, ok := job.FailurePolicy.(*JobFailurePolicyConstant); ok { |
| 128 | + constantPolicy.MaxRetries = &maxRetries |
| 129 | + } else { |
| 130 | + job.FailurePolicy = &JobFailurePolicyConstant{ |
| 131 | + MaxRetries: &maxRetries, |
| 132 | + } |
| 133 | + } |
| 134 | + } |
| 135 | +} |
| 136 | + |
| 137 | +func WithJobConstantFailurePolicyInterval(interval time.Duration) JobOption { |
| 138 | + return func(job *Job) { |
| 139 | + if job.FailurePolicy == nil { |
| 140 | + job.FailurePolicy = &JobFailurePolicyConstant{} |
| 141 | + } |
| 142 | + if constantPolicy, ok := job.FailurePolicy.(*JobFailurePolicyConstant); ok { |
| 143 | + constantPolicy.Interval = &interval |
| 144 | + } else { |
| 145 | + job.FailurePolicy = &JobFailurePolicyConstant{ |
| 146 | + Interval: &interval, |
| 147 | + } |
| 148 | + } |
| 149 | + } |
| 150 | +} |
| 151 | + |
| 152 | +func WithJobDropFailurePolicy() JobOption { |
| 153 | + return func(job *Job) { |
| 154 | + job.FailurePolicy = &JobFailurePolicyDrop{} |
| 155 | + } |
| 156 | +} |
| 157 | + |
| 158 | +// ScheduleJobAlpha1 raises and schedules a job. |
| 159 | +func (c *GRPCClient) ScheduleJobAlpha1(ctx context.Context, job *Job) error { |
| 160 | + if job.Name == "" { |
| 161 | + return errors.New("job name is required") |
| 162 | + } |
| 163 | + if job.Data == nil { |
| 164 | + return errors.New("job data is required") |
| 165 | + } |
| 166 | + |
| 167 | + jobRequest := &runtimepb.Job{ |
| 168 | + Name: job.Name, |
| 169 | + Data: job.Data, |
| 170 | + Schedule: job.Schedule, |
| 171 | + Repeats: job.Repeats, |
| 172 | + DueTime: job.DueTime, |
| 173 | + Ttl: job.TTL, |
| 174 | + } |
| 175 | + |
| 176 | + if job.FailurePolicy != nil { |
| 177 | + jobRequest.FailurePolicy = job.FailurePolicy.GetPBFailurePolicy() |
| 178 | + } |
| 179 | + _, err := c.protoClient.ScheduleJobAlpha1(ctx, &runtimepb.ScheduleJobRequest{ |
| 180 | + Job: jobRequest, |
| 181 | + Overwrite: job.Overwrite, |
| 182 | + }) |
| 183 | + return err |
| 184 | +} |
| 185 | + |
| 186 | +// GetJobAlpha1 retrieves a scheduled job. |
| 187 | +func (c *GRPCClient) GetJobAlpha1(ctx context.Context, name string) (*Job, error) { |
| 188 | + if name == "" { |
| 189 | + return nil, errors.New("job name is required") |
| 190 | + } |
| 191 | + |
| 192 | + resp, err := c.protoClient.GetJobAlpha1(ctx, &runtimepb.GetJobRequest{ |
| 193 | + Name: name, |
| 194 | + }) |
| 195 | + if err != nil { |
| 196 | + return nil, err |
| 197 | + } |
| 198 | + |
| 199 | + var failurePolicy FailurePolicy |
| 200 | + switch policy := resp.GetJob().GetFailurePolicy().GetPolicy().(type) { |
| 201 | + case *commonpb.JobFailurePolicy_Constant: |
| 202 | + interval := time.Duration(policy.Constant.GetInterval().GetSeconds()) * time.Second |
| 203 | + failurePolicy = &JobFailurePolicyConstant{ |
| 204 | + MaxRetries: ptr.Of(policy.Constant.GetMaxRetries()), |
| 205 | + Interval: &interval, |
| 206 | + } |
| 207 | + case *commonpb.JobFailurePolicy_Drop: |
| 208 | + failurePolicy = &JobFailurePolicyDrop{} |
| 209 | + } |
| 210 | + |
| 211 | + return &Job{ |
| 212 | + Name: resp.GetJob().GetName(), |
| 213 | + Schedule: ptr.Of(resp.GetJob().GetSchedule()), |
| 214 | + Repeats: ptr.Of(resp.GetJob().GetRepeats()), |
| 215 | + DueTime: ptr.Of(resp.GetJob().GetDueTime()), |
| 216 | + TTL: ptr.Of(resp.GetJob().GetTtl()), |
| 217 | + Data: resp.GetJob().GetData(), |
| 218 | + FailurePolicy: failurePolicy, |
| 219 | + }, nil |
| 220 | +} |
| 221 | + |
| 222 | +// DeleteJobAlpha1 deletes a scheduled job. |
| 223 | +func (c *GRPCClient) DeleteJobAlpha1(ctx context.Context, name string) error { |
| 224 | + if name == "" { |
| 225 | + return errors.New("job name is required") |
| 226 | + } |
| 227 | + |
| 228 | + _, err := c.protoClient.DeleteJobAlpha1(ctx, &runtimepb.DeleteJobRequest{ |
| 229 | + Name: name, |
| 230 | + }) |
| 231 | + return err |
| 232 | +} |
0 commit comments