Debian Codegraph @

pkg/services/specialized/generic/custom_query.go

raw
1 package generic
2
3 import (
4 "net/url"
5 "strings"
6 )
7
8 // Constants for character values and offsets used in header normalization and query parsing.
9 const (
10 ExtraPrefixChar = '$' // Prefix for extra data in query parameters
11 HeaderPrefixChar = '@' // Prefix for header values in query parameters
12 CaseOffset = 'a' - 'A' // Offset between lowercase and uppercase letters
13 UppercaseA = 'A' // ASCII value for uppercase A
14 UppercaseZ = 'Z' // ASCII value for uppercase Z
15 DashChar = '-' // Dash character for header formatting
16 HeaderCapacityFactor = 2 // Estimated capacity multiplier for header string builder
17 )
18
19 // normalizedHeaderKey converts a header key to HTTP header format (e.g., "ContentType" -> "content-type").
20 func normalizedHeaderKey(key string) string {
21 stringBuilder := strings.Builder{}
22 // Pre-allocate capacity for efficiency
23 stringBuilder.Grow(len(key) * HeaderCapacityFactor)
24
25 for i, c := range key {
26 if UppercaseA <= c && c <= UppercaseZ {
27 // If character is uppercase
28 if i > 0 && key[i-1] != DashChar {
29 // Add dash before uppercase if not after dash
30 stringBuilder.WriteRune(DashChar)
31 }
32 } else if i == 0 || key[i-1] == DashChar {
33 // First char or after dash: convert to lowercase
34 c -= CaseOffset
35 }
36
37 stringBuilder.WriteRune(c)
38 }
39
40 return stringBuilder.String()
41 }
42
43 // appendCustomQueryValues adds headers and extra data to URL query parameters with prefixes.
44 func appendCustomQueryValues(
45 query url.Values,
46 headers map[string]string,
47 extraData map[string]string,
48 ) {
49 for key, value := range headers {
50 // Add headers with @ prefix
51 query.Set(string(HeaderPrefixChar)+key, value)
52 }
53
54 for key, value := range extraData {
55 // Add extra data with $ prefix
56 query.Set(string(ExtraPrefixChar)+key, value)
57 }
58 }
59
60 // stripCustomQueryValues extracts headers and extra data from query parameters and removes them from the query.
61 func stripCustomQueryValues(query url.Values) (map[string]string, map[string]string) {
62 // Map for extracted headers
63 headers := make(map[string]string)
64 // Map for extracted extra data
65 extraData := make(map[string]string)
66
67 for key, values := range query {
68 // Skip keys with length <= 1 to prevent processing empty or invalid keys that could result in malformed headers or JSON fields
69 if len(key) <= 1 {
70 continue
71 }
72
73 switch key[0] {
74 case HeaderPrefixChar: // Header prefixed with @
75 // Normalize header key
76 headerKey := normalizedHeaderKey(key[1:])
77 headers[headerKey] = values[0]
78 case ExtraPrefixChar: // Extra data prefixed with $
79 extraData[key[1:]] = values[0]
80 default: // Skip non-prefixed keys
81 continue
82 }
83
84 // Remove the custom key from query
85 delete(query, key)
86 }
87
88 return headers, extraData
89 }