|
| 1 | +// Copyright (c) 2025 Uber Technologies, Inc. |
| 2 | +// |
| 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 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +package request |
| 16 | + |
| 17 | +import ( |
| 18 | + "context" |
| 19 | + "errors" |
| 20 | + "fmt" |
| 21 | + "reflect" |
| 22 | + |
| 23 | + "github.com/uber/submitqueue/submitqueue/entity" |
| 24 | + "github.com/uber/submitqueue/submitqueue/extension/storage" |
| 25 | +) |
| 26 | + |
| 27 | +const maxSummaryProjectionAttempts = 8 |
| 28 | + |
| 29 | +// CreateContext creates immutable admission data and the initial List projection. |
| 30 | +func CreateContext(ctx context.Context, store storage.Storage, requestContext entity.RequestContext) error { |
| 31 | + if err := store.GetRequestContextStore().Create(ctx, requestContext); err != nil { |
| 32 | + if !errors.Is(err, storage.ErrAlreadyExists) { |
| 33 | + return fmt.Errorf("failed to create request context request_id=%s: %w", requestContext.RequestID, err) |
| 34 | + } |
| 35 | + existing, getErr := store.GetRequestContextStore().Get(ctx, requestContext.RequestID) |
| 36 | + if getErr != nil { |
| 37 | + return fmt.Errorf("failed to verify existing request context request_id=%s: %w", requestContext.RequestID, getErr) |
| 38 | + } |
| 39 | + if !equalRequestContext(existing, requestContext) { |
| 40 | + return fmt.Errorf("request context conflicts with existing immutable context request_id=%s", requestContext.RequestID) |
| 41 | + } |
| 42 | + } |
| 43 | + |
| 44 | + summary := entity.RequestSummary{ |
| 45 | + RequestID: requestContext.RequestID, |
| 46 | + Queue: requestContext.Queue, |
| 47 | + ChangeURIs: append([]string(nil), requestContext.ChangeURIs...), |
| 48 | + Status: entity.RequestStatusAccepted, |
| 49 | + Metadata: map[string]string{}, |
| 50 | + StartedAtMs: requestContext.AdmittedAtMs, |
| 51 | + UpdatedAtMs: requestContext.AdmittedAtMs, |
| 52 | + StatusTimestampMs: requestContext.AdmittedAtMs, |
| 53 | + Version: 1, |
| 54 | + } |
| 55 | + if err := store.GetRequestSummaryStore().Create(ctx, summary); err != nil && !errors.Is(err, storage.ErrAlreadyExists) { |
| 56 | + return fmt.Errorf("failed to create request summary request_id=%s: %w", requestContext.RequestID, err) |
| 57 | + } |
| 58 | + return nil |
| 59 | +} |
| 60 | + |
| 61 | +// PersistLog appends one immutable status event and updates its summary projection. A projection error is returned so queue delivery retries. |
| 62 | +func PersistLog(ctx context.Context, store storage.Storage, log entity.RequestLog) error { |
| 63 | + if err := store.GetRequestLogStore().Insert(ctx, log); err != nil { |
| 64 | + return fmt.Errorf("failed to insert request log request_id=%s: %w", log.RequestID, err) |
| 65 | + } |
| 66 | + if err := ProjectLog(ctx, store, log); err != nil { |
| 67 | + return fmt.Errorf("failed to project request log request_id=%s: %w", log.RequestID, err) |
| 68 | + } |
| 69 | + return nil |
| 70 | +} |
| 71 | + |
| 72 | +// ProjectLog applies a status event to an existing summary using optimistic concurrency. |
| 73 | +func ProjectLog(ctx context.Context, store storage.Storage, log entity.RequestLog) error { |
| 74 | + requestContext, err := store.GetRequestContextStore().Get(ctx, log.RequestID) |
| 75 | + if err != nil { |
| 76 | + return fmt.Errorf("failed to get request context request_id=%s: %w", log.RequestID, err) |
| 77 | + } |
| 78 | + |
| 79 | + for attempt := 0; attempt < maxSummaryProjectionAttempts; attempt++ { |
| 80 | + existing, err := store.GetRequestSummaryStore().Get(ctx, requestContext.Queue, log.RequestID) |
| 81 | + if err != nil { |
| 82 | + return fmt.Errorf("failed to get request summary request_id=%s: %w", log.RequestID, err) |
| 83 | + } |
| 84 | + next := MergeSummary(existing, log) |
| 85 | + newVersion := existing.Version + 1 |
| 86 | + if err := store.GetRequestSummaryStore().Update(ctx, next, existing.Version, newVersion); err == nil { |
| 87 | + return nil |
| 88 | + } else if !errors.Is(err, storage.ErrVersionMismatch) { |
| 89 | + return fmt.Errorf("failed to update request summary request_id=%s: %w", log.RequestID, err) |
| 90 | + } |
| 91 | + } |
| 92 | + return fmt.Errorf("request summary projection did not converge request_id=%s: %w", log.RequestID, storage.ErrVersionMismatch) |
| 93 | +} |
| 94 | + |
| 95 | +// MergeSummary returns the summary that results when log is reconciled against existing. |
| 96 | +func MergeSummary(existing entity.RequestSummary, log entity.RequestLog) entity.RequestSummary { |
| 97 | + next := existing |
| 98 | + if !shouldReplaceWinner(existing, log) { |
| 99 | + return next |
| 100 | + } |
| 101 | + next.Status = log.Status |
| 102 | + next.LastError = log.LastError |
| 103 | + next.Metadata = cloneMetadata(log.Metadata) |
| 104 | + next.UpdatedAtMs = log.TimestampMs |
| 105 | + next.RequestVersion = log.RequestVersion |
| 106 | + next.StatusTimestampMs = log.TimestampMs |
| 107 | + next.WinnerTerminalVersion = isTerminalVersion(log) |
| 108 | + if entity.IsRequestStateTerminal(entity.RequestState(string(log.Status))) { |
| 109 | + next.CompletedAtMs = log.TimestampMs |
| 110 | + } else { |
| 111 | + next.CompletedAtMs = 0 |
| 112 | + } |
| 113 | + return next |
| 114 | +} |
| 115 | + |
| 116 | +func shouldReplaceWinner(existing entity.RequestSummary, log entity.RequestLog) bool { |
| 117 | + incomingTerminalVersion := isTerminalVersion(log) |
| 118 | + if incomingTerminalVersion { |
| 119 | + if !existing.WinnerTerminalVersion { |
| 120 | + return true |
| 121 | + } |
| 122 | + return log.RequestVersion > existing.RequestVersion || (log.RequestVersion == existing.RequestVersion && log.TimestampMs > existing.StatusTimestampMs) |
| 123 | + } |
| 124 | + if existing.WinnerTerminalVersion { |
| 125 | + return false |
| 126 | + } |
| 127 | + return log.TimestampMs > existing.StatusTimestampMs |
| 128 | +} |
| 129 | + |
| 130 | +func isTerminalVersion(log entity.RequestLog) bool { |
| 131 | + return log.RequestVersion > 0 && entity.IsRequestStateTerminal(entity.RequestState(string(log.Status))) |
| 132 | +} |
| 133 | + |
| 134 | +func cloneMetadata(metadata map[string]string) map[string]string { |
| 135 | + if metadata == nil { |
| 136 | + return map[string]string{} |
| 137 | + } |
| 138 | + clone := make(map[string]string, len(metadata)) |
| 139 | + for key, value := range metadata { |
| 140 | + clone[key] = value |
| 141 | + } |
| 142 | + return clone |
| 143 | +} |
| 144 | + |
| 145 | +func equalRequestContext(left, right entity.RequestContext) bool { |
| 146 | + return left.RequestID == right.RequestID && |
| 147 | + left.Queue == right.Queue && |
| 148 | + left.AdmittedAtMs == right.AdmittedAtMs && |
| 149 | + reflect.DeepEqual(left.ChangeURIs, right.ChangeURIs) |
| 150 | +} |
0 commit comments