Vihren Atlas

Atlas › Test

reader

go.temporal.io/server/common/nexus/nexusrpc/TestReaderIO/reader

Package
go.temporal.io/server/common/nexus/nexusrpc
Suite / test hierarchy
TestReaderIO/reader
Test
reader
Introduced at
client.go ×1 Joint frontier
Covered ranges
112
Covered lines
281
Covered files
4

Covered source

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

go.temporal.io/server/common/nexus/nexusrpc/api.go 114 covered LOC · 56 ranges

Open complete file

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. api.go
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) api.go
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) api.go
82 > if err != nil {
83 return err
84 }
85 > httpHeader.Add(headerLink, encodedLink) api.go
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
95 }
96 > for encodedLink := range strings.SplitSeq(strings.Join(headerValues, ","), ",") { api.go
97 > link, err := decodeLink(encodedLink)
98 > if err != nil {
99 return nil, err
100 }
101 > links = append(links, link) api.go
102 }
103 > return links, nil api.go
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 api.go
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
140 // decodeLink encodes the link to Nexus-Link header value.
141 // It follows the same format of HTTP Link header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link
142 > func encodeLink(link nexus.Link) (string, error) { api.go
143 > if err := validateLinkURL(link.URL); err != nil {
144 return "", fmt.Errorf("failed to encode link: %w", err)
145 }
146 > if err := validateLinkType(link.Type); err != nil { api.go
147 return "", fmt.Errorf("failed to encode link: %w", err)
148 }
149 > return fmt.Sprintf(`<%s>; %s="%s"`, link.URL.String(), linkTypeKey, link.Type), nil api.go
150 }
151
152 // decodeLink decodes the Nexus-Link header values.
153 // It must have the same format of HTTP Link header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link
154 > func decodeLink(encodedLink string) (nexus.Link, error) { api.go
155 > var link nexus.Link
156 > encodedLink = strings.TrimSpace(encodedLink)
157 > if len(encodedLink) == 0 {
158 return link, errors.New("failed to parse link header: value is empty")
159 }
160
161 > if encodedLink[0] != '<' { api.go
162 return link, fmt.Errorf("failed to parse link header: invalid format: %s", encodedLink)
163 }
164 > urlEnd := strings.Index(encodedLink, ">") api.go
165 > if urlEnd == -1 {
166 return link, fmt.Errorf("failed to parse link header: invalid format: %s", encodedLink)
167 }
168 > urlStr := strings.TrimSpace(encodedLink[1:urlEnd]) api.go
169 > if len(urlStr) == 0 {
170 return link, errors.New("failed to parse link header: url is empty")
171 }
172 > u, err := url.Parse(urlStr) api.go
173 > if err != nil {
174 return link, fmt.Errorf("failed to parse link header: invalid url: %s", urlStr)
175 }
176 > if err := validateLinkURL(u); err != nil { api.go
177 return link, fmt.Errorf("failed to parse link header: %w", err)
178 }
179 > link.URL = u api.go
180 >
181 > params := strings.Split(encodedLink[urlEnd+1:], ";")
182 > // must contain at least one semi-colon, and first param must be empty since
183 > // it corresponds to the url part parsed above.
184 > if len(params) < 2 {
185 return link, fmt.Errorf("failed to parse link header: invalid format: %s", encodedLink)
186 }
187 > if strings.TrimSpace(params[0]) != "" { api.go
188 return link, fmt.Errorf("failed to parse link header: invalid format: %s", encodedLink)
189 }
190
191 > typeKeyFound := false api.go
192 > for _, param := range params[1:] {
193 > param = strings.TrimSpace(param)
194 > if len(param) == 0 {
195 return link, fmt.Errorf("failed to parse link header: parameter is empty: %s", encodedLink)
196 }
197 > kv := strings.SplitN(param, "=", 2) api.go
198 > if len(kv) != 2 {
199 return link, fmt.Errorf("failed to parse link header: invalid parameter format: %s", param)
200 }
201 > key := strings.TrimSpace(kv[0]) api.go
202 > val := strings.TrimSpace(kv[1])
203 > if strings.HasPrefix(val, `"`) != strings.HasSuffix(val, `"`) {
204 return link, fmt.Errorf(
205 "failed to parse link header: parameter value missing double-quote: %s",
207 )
208 }
209 > if strings.HasPrefix(val, `"`) { api.go
210 > val = val[1 : len(val)-1] api.go
211 > }
212 > if key == linkTypeKey { api.go
213 > if err := validateLinkType(val); err != nil {
214 return link, fmt.Errorf("failed to parse link header: %w", err)
215 }
216 > link.Type = val api.go
217 > typeKeyFound = true
218 }
219 }
220 > if !typeKeyFound { api.go
221 return link, fmt.Errorf(
222 "failed to parse link header: %q key not found: %s",
226 }
227
228 > return link, nil api.go
229 }
230
231 > func validateLinkURL(value *url.URL) error { api.go
232 > if value == nil || value.String() == "" {
233 return errors.New("url is empty")
234 }
235 > _, err := url.ParseQuery(value.RawQuery) api.go
236 > if err != nil {
237 return fmt.Errorf("url query not percent-encoded: %s", value)
238 }
239 > return nil api.go
240 }
241
242 > func validateLinkType(value string) error { api.go
243 > if len(value) == 0 {
244 return errors.New("link type is empty")
245 }
246 > for _, c := range value { api.go
247 > if (c < 'a' || c > 'z') && (c < 'A' || c > 'Z') && (c < '0' || c > '9') && c != '_' && c != '.' && c != '/' {
248 return errors.New("link type contains invalid char (valid chars: alphanumeric, '_', '.', '/')")
249 }
250 }
251 > return nil api.go
252 }
253
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/server.go 95 covered LOC · 33 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 }: server.go
24 > handler.writeResult(writer, request, r.ValueAsAny())
25 case *nexus.HandlerStartOperationResultAsync:
26 info := nexus.OperationInfo{
53 }
54
55 > func (h *httpHandler) writeResult(writer http.ResponseWriter, request *http.Request, result any) { server.go
56 > var reader *nexus.Reader
57 > if r, ok := result.(*nexus.Reader); ok {
58 > // Close the request body in case we error before sending the HTTP request (which may double close but server.go
59 > // that's fine since we ignore the error).
60 > // nolint:errcheck // ignore error on close
61 > defer r.Close()
62 > reader = r
63 > } else { server.go
64 content, ok := result.(*nexus.Content)
65 if !ok {
80 }
81
82 > header := writer.Header() server.go
83 > addContentHeaderToHTTPHeader(reader.Header, header)
84 > if reader.ReadCloser == nil {
85 return
86 }
87 > if _, err := io.Copy(writer, reader); err != nil { server.go
88 h.Logger.Error("failed to write response body", "error", err)
89 }
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 }
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
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 69 covered LOC · 22 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 client.go
232 > // that's fine since we ignore the error).
233 > // nolint:errcheck // double close is fine
234 > defer r.Close()
235 > reader = r
236 > } else { client.go
237 content, ok := input.(*nexus.Content)
238 if !ok {
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
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]{ client.go
312 > Successful: nexus.NewLazyValue(
313 > c.serializer,
314 > &nexus.Reader{
315 > ReadCloser: response.Body,
316 > Header: prefixStrippedHTTPHeaderToNexusHeader(response.Header, "content-"),
317 > },
318 > ),
319 > Links: links,
320 > }, nil
321 > }
322
323 // Do this once here and make sure it doesn't leak.
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 {