Vihren Atlas

Atlas › Test

TestCancel_HandleFromStart

go.temporal.io/server/common/nexus/nexusrpc/TestCancel_HandleFromStart

Package
go.temporal.io/server/common/nexus/nexusrpc
Suite / test hierarchy
TestCancel_HandleFromStart
Test
TestCancel_HandleFromStart
Introduced at
TestCancel_HandleFromStart Test frontier
Covered ranges
108
Covered lines
288
Covered files
5

Covered source

Expand a file to inspect source; the > gutter marks covered lines.

go.temporal.io/server/common/nexus/nexusrpc/server.go 113 covered LOC · 37 ranges

Open complete file

19 )
20
21 > func applyResultToHTTPResponse(r nexus.HandlerStartOperationResult[any], writer http.ResponseWriter, request *http.Request, handler *httpHandler) { server.go
22 > switch r := r.(type) {
23 case interface{ ValueAsAny() any }:
24 handler.writeResult(writer, request, r.ValueAsAny())
25 > case *nexus.HandlerStartOperationResultAsync: server.go
26 > info := nexus.OperationInfo{
27 > Token: r.OperationToken,
28 > State: nexus.OperationStateRunning,
29 > }
30 > b, err := json.Marshal(info)
31 > if err != nil {
32 handler.Logger.Error("failed to serialize operation info", "error", err)
33 writer.WriteHeader(http.StatusInternalServerError)
35 }
36
37 > writer.Header().Set("Content-Type", contentTypeJSON) server.go
38 > writer.WriteHeader(http.StatusCreated)
39 > if _, err := writer.Write(b); err != nil {
40 handler.Logger.Error("failed to write response body", "error", err)
41 }
198 }
199
200 > func (h *httpHandler) startOperation(service, operation string, writer http.ResponseWriter, request *http.Request) { server.go
201 > links, err := getLinksFromHeader(request.Header)
202 > if err != nil {
203 h.WriteFailure(writer, request, nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid %q header", headerLink))
204 return
205 }
206 > options := nexus.StartOperationOptions{ server.go
207 > RequestID: request.Header.Get(headerRequestID),
208 > CallbackURL: request.URL.Query().Get(queryCallbackURL),
209 > CallbackHeader: prefixStrippedHTTPHeaderToNexusHeader(request.Header, "nexus-callback-"),
210 > Header: httpHeaderToNexusHeader(request.Header, "content-", "nexus-callback-"),
211 > Links: links,
212 > }
213 > value := nexus.NewLazyValue(
214 > h.options.Serializer,
215 > &nexus.Reader{
216 > ReadCloser: request.Body,
217 > Header: prefixStrippedHTTPHeaderToNexusHeader(request.Header, "content-"),
218 > },
219 > )
220 >
221 > ctx, cancel, ok := h.contextWithTimeoutFromHTTPRequest(writer, request)
222 > if !ok {
223 return
224 }
225 > defer cancel() server.go
226 >
227 > ctx = nexus.WithHandlerContext(ctx, nexus.HandlerInfo{
228 > Service: service,
229 > Operation: operation,
230 > Header: options.Header,
231 > })
232 > response, err := h.options.Handler.StartOperation(ctx, service, operation, value, options)
233 > if err != nil {
234 h.WriteFailure(writer, request, err)
235 > } else { server.go
236 > if err := addLinksToHTTPHeader(nexus.HandlerLinks(ctx), writer.Header()); err != nil { server.go
237 h.Logger.Error("failed to serialize links into header", "error", err)
238 // clear any previous links already written to the header
241 return
242 }
243 > applyResultToHTTPResponse(response, writer, request, h) server.go
244 }
245 }
246
247 > func (h *httpHandler) cancelOperation(service, operation, token string, writer http.ResponseWriter, request *http.Request) { server.go
248 > options := nexus.CancelOperationOptions{Header: httpHeaderToNexusHeader(request.Header)}
249 >
250 > ctx, cancel, ok := h.contextWithTimeoutFromHTTPRequest(writer, request)
251 > if !ok {
252 return
253 }
254 > defer cancel() server.go
255 >
256 > ctx = nexus.WithHandlerContext(ctx, nexus.HandlerInfo{
257 > Service: service,
258 > Operation: operation,
259 > Header: options.Header,
260 > })
261 > if err := h.options.Handler.CancelOperation(ctx, service, operation, token, options); err != nil {
262 h.WriteFailure(writer, request, err)
263 return
264 }
265
266 > writer.WriteHeader(http.StatusAccepted) server.go
267 }
268
270 // Returns (0, true) if unset. Returns ({parsedDuration}, true) if set. If set and there is an error parsing the
271 // duration, it writes a failure response and returns (0, false).
272 > func (h *httpHandler) parseRequestTimeoutHeader(writer http.ResponseWriter, request *http.Request) (time.Duration, bool) { server.go
273 > timeoutStr := request.Header.Get(nexus.HeaderRequestTimeout)
274 > if timeoutStr != "" {
275 > timeoutDuration, err := ParseDuration(timeoutStr) server.go
276 > if err != nil {
277 h.Logger.Warn("invalid request timeout header", "timeout", timeoutStr)
278 h.WriteFailure(writer, request, nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid request timeout header"))
279 return 0, false
280 }
281 > return timeoutDuration, true server.go
282 }
283 return 0, true
286 // contextWithTimeoutFromHTTPRequest extracts the context from the HTTP request and applies the timeout indicated by
287 // the Request-Timeout header, if set.
288 > func (h *httpHandler) contextWithTimeoutFromHTTPRequest(writer http.ResponseWriter, request *http.Request) (context.Context, context.CancelFunc, bool) { server.go
289 > requestTimeout, ok := h.parseRequestTimeoutHeader(writer, request)
290 > if !ok {
291 return nil, nil, false
292 }
293 > if requestTimeout > 0 { server.go
294 > ctx, cancel := context.WithTimeout(request.Context(), requestTimeout) server.go
295 > return ctx, cancel, true
296 > }
297 return request.Context(), func() {}, true
298 }
318 }
319
320 > func (h *httpHandler) handleRequest(writer http.ResponseWriter, request *http.Request) { server.go
321 > if request.Method != "POST" {
322 h.WriteFailure(writer, request, nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "invalid request method: expected POST, got %q", request.Method))
323 return
324 }
325 > parts := strings.Split(request.URL.EscapedPath(), "/") server.go
326 > // First part is empty (due to leading /)
327 > if len(parts) < 3 {
328 h.WriteFailure(writer, request, nexus.NewHandlerErrorf(nexus.HandlerErrorTypeNotFound, "not found"))
329 return
330 }
331 > service, err := url.PathUnescape(parts[1]) server.go
332 > if err != nil {
333 h.WriteFailure(writer, request, nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "failed to parse URL path"))
334 return
335 }
336 > operation, err := url.PathUnescape(parts[2]) server.go
337 > if err != nil {
338 h.WriteFailure(writer, request, nexus.NewHandlerErrorf(nexus.HandlerErrorTypeBadRequest, "failed to parse URL path"))
339 return
341
342 // First handle StartOperation at /{service}/{operation}
343 > if len(parts) == 3 { server.go
344 > h.startOperation(service, operation, writer, request) server.go
345 > return
346 > }
347
348 // Handle deprecated /{service}/{operation}/{operation_token}/cancel
349 // TODO(bergundy): remove in server release v1.31.0
350 > if len(parts) == 5 && parts[4] == "cancel" { server.go
351 token, err := url.PathUnescape(parts[3])
352 if err != nil {
359 }
360
361 > if len(parts) != 4 || parts[3] != "cancel" { server.go
362 h.WriteFailure(writer, request, nexus.NewHandlerErrorf(nexus.HandlerErrorTypeNotFound, "not found"))
363 return
364 }
365
366 > token := request.Header.Get(nexus.HeaderOperationToken) server.go
367 > if token == "" {
368 token = request.URL.Query().Get("token")
369 if token == "" {
371 return
372 }
373 > } else { server.go
374 > // Sanitize this header as it is explicitly passed in as an argument.
375 > request.Header.Del(nexus.HeaderOperationToken)
376 > }
377
378 > h.cancelOperation(service, operation, token, writer, request) server.go
379 }
380
381 // NewHTTPHandler constructs an [http.Handler] from given options for handling Nexus service requests.
382 > func NewHTTPHandler(options HandlerOptions) http.Handler { server.go
383 > if options.Logger == nil {
384 > options.Logger = slog.Default() server.go
385 > }
386 > if options.GetResultTimeout == 0 { server.go
387 options.GetResultTimeout = time.Minute
388 }
389 > if options.Serializer == nil { server.go
390 > options.Serializer = nexus.DefaultSerializer() server.go
391 > }
392 > if options.FailureConverter == nil { server.go
393 > options.FailureConverter = DefaultFailureConverter() server.go
394 > }
395 > handler := &httpHandler{ server.go
396 > BaseHTTPHandler: BaseHTTPHandler{
397 > Logger: options.Logger,
398 > FailureConverter: options.FailureConverter,
399 > },
400 > options: options,
401 > }
402 >
403 > return http.HandlerFunc(handler.handleRequest)
404 }
go.temporal.io/server/common/nexus/nexusrpc/client.go 103 covered LOC · 40 ranges

Open complete file

152 // NewHTTPClient creates a new [HTTPClient] from provided [HTTPClientOptions].
153 // BaseURL and Service are required.
154 > func NewHTTPClient(options HTTPClientOptions) (*HTTPClient, error) { client.go
155 > if options.HTTPCaller == nil {
156 > options.HTTPCaller = http.DefaultClient.Do
157 > }
158 > if options.BaseURL == "" {
159 return nil, errors.New("empty BaseURL")
160 }
161 > if options.Service == "" { client.go
162 return nil, errors.New("empty Service")
163 }
164 > var baseURL *url.URL client.go
165 > var err error
166 > baseURL, err = url.Parse(options.BaseURL)
167 > if err != nil {
168 return nil, err
169 }
170 > if baseURL.Scheme != "http" && baseURL.Scheme != "https" { client.go
171 return nil, fmt.Errorf("invalid URL scheme: %s", baseURL.Scheme)
172 }
173 > if options.Serializer == nil { client.go
174 > options.Serializer = nexus.DefaultSerializer() client.go
175 > }
176 > if options.FailureConverter == nil { client.go
177 > options.FailureConverter = DefaultFailureConverter() client.go
178 > }
179 > return &HTTPClient{ client.go
180 > baseHTTPClient: baseHTTPClient{
181 > serializer: options.Serializer,
182 > failureConverter: options.FailureConverter,
183 > httpCaller: options.HTTPCaller,
184 > },
185 > serviceBaseURL: baseURL,
186 > service: options.Service,
187 > }, nil
188 }
189
225 input any,
226 options nexus.StartOperationOptions,
227 > ) (*ClientStartOperationResponse[*nexus.LazyValue], error) { client.go
228 > var reader *nexus.Reader
229 > var contentLength *int64
230 > if r, ok := input.(*nexus.Reader); ok {
231 // Close the input reader in case we error before sending the HTTP request (which may double close but
232 // that's fine since we ignore the error).
234 defer r.Close()
235 reader = r
236 > } else { client.go
237 > content, ok := input.(*nexus.Content) client.go
238 > if !ok {
239 > var err error client.go
240 > content, err = c.serializer.Serialize(input)
241 > if err != nil {
242 return nil, err
243 }
244 }
245 > header := maps.Clone(content.Header) client.go
246 > if header == nil {
247 header = make(nexus.Header, 1)
248 }
249 > contentLength = new(int64) client.go
250 > *contentLength = int64(len(content.Data))
251 >
252 > reader = &nexus.Reader{
253 > ReadCloser: io.NopCloser(bytes.NewReader(content.Data)),
254 > Header: header,
255 > }
256 }
257
258 > url := c.serviceBaseURL.JoinPath(url.PathEscape(c.service), url.PathEscape(operation)) client.go
259 >
260 > if options.CallbackURL != "" {
261 q := url.Query()
262 q.Set(queryCallbackURL, options.CallbackURL)
263 url.RawQuery = q.Encode()
264 }
265 > request, err := http.NewRequestWithContext(ctx, "POST", url.String(), reader) client.go
266 > if contentLength != nil {
267 > request.ContentLength = *contentLength client.go
268 > }
269 > if err != nil { client.go
270 return nil, err
271 }
272
273 > if options.RequestID == "" { client.go
274 > options.RequestID = uuid.NewString() client.go
275 > }
276 > request.Header.Set(headerRequestID, options.RequestID) client.go
277 > request.Header.Set(headerUserAgent, userAgent)
278 > addContentHeaderToHTTPHeader(reader.Header, request.Header)
279 > addCallbackHeaderToHTTPHeader(options.CallbackHeader, request.Header)
280 > if err := addLinksToHTTPHeader(options.Links, request.Header); err != nil {
281 return nil, fmt.Errorf("failed to serialize links into header: %w", err)
282 }
283 > addContextTimeoutToHTTPHeader(ctx, request.Header) client.go
284 > addNexusHeaderToHTTPHeader(options.Header, request.Header)
285 >
286 > response, err := c.httpCaller(request)
287 > if err != nil {
288 return nil, err
289 }
290
291 > links, err := getLinksFromHeader(response.Header) client.go
292 > if err != nil {
293 // Have to read body here to check if it is a Failure.
294 body, err := readAndReplaceBody(response)
308
309 // Do not close response body here to allow successful result to read it.
310 > if response.StatusCode == http.StatusOK { client.go
311 return &ClientStartOperationResponse[*nexus.LazyValue]{
312 Successful: nexus.NewLazyValue(
322
323 // Do this once here and make sure it doesn't leak.
324 > body, err := readAndReplaceBody(response) client.go
325 > if err != nil {
326 return nil, err
327 }
328
329 > switch response.StatusCode { client.go
330 > case http.StatusCreated: client.go
331 > info, err := operationInfoFromResponse(response, body)
332 > if err != nil {
333 return nil, err
334 }
335 > if info.State != nexus.OperationStateRunning { client.go
336 return nil, newUnexpectedResponseError(fmt.Sprintf("invalid operation state in response info: %q", info.State), response, body)
337 }
338 > handle, err := c.NewOperationHandle(operation, info.Token) client.go
339 > if err != nil {
340 return nil, newUnexpectedResponseError("empty operation token in response", response, body)
341 }
342 > return &ClientStartOperationResponse[*nexus.LazyValue]{ client.go
343 > Pending: handle,
344 > Links: links,
345 > }, nil
346 case statusOperationUnsuccessful:
347 failure, err := c.failureFromResponse(response, body)
381 // Does not incur a trip to the server.
382 // Fails if provided an empty operation or token.
383 > func (c *HTTPClient) NewOperationHandle(operation string, token string) (*OperationHandle[*nexus.LazyValue], error) { client.go
384 > var es []error
385 > if operation == "" {
386 es = append(es, errEmptyOperationName)
387 }
388 > if token == "" { client.go
389 es = append(es, errEmptyOperationToken)
390 }
391 > if len(es) > 0 { client.go
392 return nil, errors.Join(es...)
393 }
394 > return &OperationHandle[*nexus.LazyValue]{ client.go
395 > client: c,
396 > Operation: operation,
397 > Token: token,
398 > }, nil
399 }
400
402 // body with an in-memory buffer.
403 // The body is replaced even when there was an error reading the entire body.
404 > func readAndReplaceBody(response *http.Response) ([]byte, error) { client.go
405 > responseBody := response.Body
406 > body, err := io.ReadAll(responseBody)
407 > if err := responseBody.Close(); err != nil {
408 return nil, err
409 }
410 > response.Body = io.NopCloser(bytes.NewReader(body)) client.go
411 > return body, err
412 }
413
414 > func operationInfoFromResponse(response *http.Response, body []byte) (*nexus.OperationInfo, error) { client.go
415 > if !isMediaTypeJSON(response.Header.Get("Content-Type")) {
416 return nil, newUnexpectedResponseError(fmt.Sprintf("invalid response content type: %q", response.Header.Get("Content-Type")), response, body)
417 }
418 > var info nexus.OperationInfo client.go
419 > if err := json.Unmarshal(body, &info); err != nil {
420 return nil, err
421 }
422 > return &info, nil client.go
423 }
424
go.temporal.io/server/common/nexus/nexusrpc/api.go 55 covered LOC · 25 ranges

Open complete file

43 const statusOperationUnsuccessful = http.StatusFailedDependency
44
45 > func isMediaTypeJSON(contentType string) bool { api.go
46 > if contentType == "" {
47 return false
48 }
49 > mediaType, _, err := mime.ParseMediaType(contentType) api.go
50 > return err == nil && mediaType == "application/json"
51 }
52
53 > func prefixStrippedHTTPHeaderToNexusHeader(httpHeader http.Header, prefix string) nexus.Header { api.go
54 > header := nexus.Header{}
55 > for k, v := range httpHeader {
56 > lowerK := strings.ToLower(k)
57 > if strings.HasPrefix(lowerK, prefix) {
58 // Nexus headers can only have single values, ignore multiple values.
59 header[lowerK[len(prefix):]] = v[0]
60 }
61 }
62 > return header api.go
63 }
64
65 > func addContentHeaderToHTTPHeader(nexusHeader nexus.Header, httpHeader http.Header) http.Header { api.go
66 > for k, v := range nexusHeader {
67 httpHeader.Set("Content-"+k, v)
68 }
69 > return httpHeader api.go
70 }
71
72 > func addCallbackHeaderToHTTPHeader(nexusHeader nexus.Header, httpHeader http.Header) http.Header { api.go
73 > for k, v := range nexusHeader {
74 httpHeader.Set("Nexus-Callback-"+k, v)
75 }
76 > return httpHeader api.go
77 }
78
79 > func addLinksToHTTPHeader(links []nexus.Link, httpHeader http.Header) error { api.go
80 > for _, link := range links {
81 encodedLink, err := encodeLink(link)
82 if err != nil {
85 httpHeader.Add(headerLink, encodedLink)
86 }
87 > return nil api.go
88 }
89
90 > func getLinksFromHeader(httpHeader http.Header) ([]nexus.Link, error) { api.go
91 > var links []nexus.Link
92 > headerValues := httpHeader.Values(headerLink)
93 > if len(headerValues) == 0 {
94 > return nil, nil api.go
95 > }
96 for encodedLink := range strings.SplitSeq(strings.Join(headerValues, ","), ",") {
97 link, err := decodeLink(encodedLink)
104 }
105
106 > func httpHeaderToNexusHeader(httpHeader http.Header, excludePrefixes ...string) nexus.Header { api.go
107 > header := nexus.Header{}
108 > headerLoop:
109 > for k, v := range httpHeader {
110 > lowerK := strings.ToLower(k)
111 > for _, prefix := range excludePrefixes {
112 > if strings.HasPrefix(lowerK, prefix) { api.go
113 continue headerLoop
114 }
115 }
116 // Nexus headers can only have single values, ignore multiple values.
117 > header[lowerK] = v[0] api.go
118 }
119 > return header api.go
120 }
121
122 > func addNexusHeaderToHTTPHeader(nexusHeader nexus.Header, httpHeader http.Header) http.Header { api.go
123 > for k, v := range nexusHeader {
124 > httpHeader.Set(k, v) api.go
125 > }
126 > return httpHeader api.go
127 }
128
129 > func addContextTimeoutToHTTPHeader(ctx context.Context, httpHeader http.Header) http.Header { api.go
130 > deadline, ok := ctx.Deadline()
131 > if !ok {
132 return httpHeader
133 }
134 > httpHeader.Set(nexus.HeaderRequestTimeout, FormatDuration(time.Until(deadline))) api.go
135 > return httpHeader
136 }
137
254 var durationRegexp = regexp.MustCompile(`^(\d+(?:\.\d+)?)(ms|s|m)$`)
255
256 > func ParseDuration(value string) (time.Duration, error) { api.go
257 > m := durationRegexp.FindStringSubmatch(value)
258 > if len(m) == 0 {
259 return 0, fmt.Errorf("invalid duration: %q", value)
260 }
261 > v, err := strconv.ParseFloat(m[1], 64) api.go
262 > if err != nil {
263 return 0, err
264 }
265
266 > switch m[2] { api.go
267 > case "ms":
268 > return time.Millisecond * time.Duration(v), nil
269 case "s":
270 return time.Millisecond * time.Duration(v*1e3), nil
277
278 // FormatDuration converts a duration into a string representation in millisecond resolution.
279 > func FormatDuration(d time.Duration) string { api.go
280 > return strconv.FormatInt(d.Milliseconds(), 10) + "ms"
281 > }
282
283 // MarkAsWrapperError adds the "unwrap-error" metadata to the original failure of the given OperationError, which
go.temporal.io/server/common/nexus/nexusrpc/handle.go 14 covered LOC · 5 ranges

Open complete file

22 //
23 // Cancelation is asynchronous and may be not be respected by the operation's implementation.
24 > func (h *OperationHandle[T]) Cancel(ctx context.Context, options nexus.CancelOperationOptions) error { handle.go
25 > u := h.client.serviceBaseURL.JoinPath(url.PathEscape(h.client.service), url.PathEscape(h.Operation), "cancel")
26 > request, err := http.NewRequestWithContext(ctx, "POST", u.String(), nil)
27 > if err != nil {
28 return err
29 }
30 > request.Header.Set(nexus.HeaderOperationToken, h.Token) handle.go
31 > addContextTimeoutToHTTPHeader(ctx, request.Header)
32 > request.Header.Set(headerUserAgent, userAgent)
33 > addNexusHeaderToHTTPHeader(options.Header, request.Header)
34 > response, err := h.client.httpCaller(request)
35 > if err != nil {
36 return err
37 }
38
39 // Do this once here and make sure it doesn't leak.
40 > body, err := readAndReplaceBody(response) handle.go
41 > if err != nil {
42 return err
43 }
44
45 > if response.StatusCode != http.StatusAccepted { handle.go
46 return h.client.bestEffortHandlerErrorFromResponse(response, body)
47 }
48 > return nil handle.go
49 }
go.temporal.io/server/common/nexus/nexusrpc/failure_converter.go 3 covered LOC · 1 range

Open complete file

196 // [Failure] instances are converted to [FailureError] to allow access to the full failure metadata and details if
197 // available.
198 > func DefaultFailureConverter() FailureConverter { failure_converter.go
199 > return defaultFailureConverter
200 > }
201
202 func retryBehaviorAsOptionalBool(e *nexus.HandlerError) *bool {