github.com/kaydxh/golang@v0.0.131/go/net/http/http_request_id.go (about)

     1  /*
     2   *Copyright (c) 2022, kaydxh
     3   *
     4   *Permission is hereby granted, free of charge, to any person obtaining a copy
     5   *of this software and associated documentation files (the "Software"), to deal
     6   *in the Software without restriction, including without limitation the rights
     7   *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   *copies of the Software, and to permit persons to whom the Software is
     9   *furnished to do so, subject to the following conditions:
    10   *
    11   *The above copyright notice and this permission notice shall be included in all
    12   *copies or substantial portions of the Software.
    13   *
    14   *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   *SOFTWARE.
    21   */
    22  package http
    23  
    24  import (
    25  	"context"
    26  	"net/http"
    27  
    28  	context_ "github.com/kaydxh/golang/go/context"
    29  )
    30  
    31  // RequestIdKey is metadata key name for request ID
    32  const (
    33  	DefaultHTTPRequestIDKey = "X-Request-ID"
    34  )
    35  
    36  func ExtractRequestIdHTTPAndContext(r *http.Request) string {
    37  	return ExtractHTTPAndContext(r, DefaultHTTPRequestIDKey)
    38  }
    39  
    40  func ExtractHTTPAndContext(r *http.Request, key string) string {
    41  	if value := ExtractFromHTTP(r, key); value != "" {
    42  		return value
    43  	}
    44  
    45  	return context_.ExtractFromContext(r.Context(), key)
    46  }
    47  
    48  func ExtractFromHTTP(r *http.Request, key string) string {
    49  	if value := r.Header.Get(key); value != "" {
    50  		return value
    51  	}
    52  	if value := r.URL.Query().Get(key); value != "" {
    53  		return value
    54  	}
    55  	if value := r.FormValue(key); value != "" {
    56  		return value
    57  	}
    58  	if value := r.PostFormValue(key); value != "" {
    59  		return value
    60  	}
    61  
    62  	return ""
    63  }
    64  
    65  /*
    66  func ExtractRequestIDFromContext(ctx context.Context) string {
    67  
    68  	if v, ok := ctx.Value(DefaultHTTPRequestIDKey).(string); ok {
    69  		return v
    70  	}
    71  
    72  	return ""
    73  }
    74  
    75  func ExtractFromContext(ctx context.Context, key string) string {
    76  	switch requestIDs := ctx.Value(key).(type) {
    77  	case string:
    78  		if requestIDs != "" {
    79  			return requestIDs
    80  		}
    81  	case []string:
    82  		if len(requestIDs) > 0 {
    83  			return requestIDs[0]
    84  		}
    85  	default:
    86  		return ""
    87  	}
    88  
    89  	return ""
    90  }
    91  */
    92  
    93  func SetPairContext(r *http.Request, key, value string) *http.Request {
    94  	ctx := context.WithValue(r.Context(), key, value)
    95  	r = r.WithContext(ctx)
    96  
    97  	return r
    98  }
    99  
   100  func SetRequestIdContext(r *http.Request, requestID string) *http.Request {
   101  	return SetPairContext(r, DefaultHTTPRequestIDKey, requestID)
   102  }