configdirector-server-sdk 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (162) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +2 -0
  3. data/CHANGELOG.md +254 -0
  4. data/LICENSE +21 -0
  5. data/README.md +230 -0
  6. data/lib/configdirector/client_hooks.rb +46 -0
  7. data/lib/configdirector/config_director_client.rb +322 -0
  8. data/lib/configdirector/config_evaluated_event.rb +10 -0
  9. data/lib/configdirector/config_evaluation.rb +51 -0
  10. data/lib/configdirector/config_state.rb +39 -0
  11. data/lib/configdirector/configs_updated_event.rb +23 -0
  12. data/lib/configdirector/connection_error_event.rb +11 -0
  13. data/lib/configdirector/connection_options.rb +60 -0
  14. data/lib/configdirector/context.rb +53 -0
  15. data/lib/configdirector/errors.rb +29 -0
  16. data/lib/configdirector/internal/client/client_connection.rb +119 -0
  17. data/lib/configdirector/internal/client/client_factory.rb +104 -0
  18. data/lib/configdirector/internal/client/client_options_validation.rb +53 -0
  19. data/lib/configdirector/internal/client/config_read.rb +31 -0
  20. data/lib/configdirector/internal/client/config_reader.rb +55 -0
  21. data/lib/configdirector/internal/client/connection_intake.rb +59 -0
  22. data/lib/configdirector/internal/client/connection_options_validation.rb +94 -0
  23. data/lib/configdirector/internal/client/context_admission.rb +48 -0
  24. data/lib/configdirector/internal/client/context_attributes.rb +78 -0
  25. data/lib/configdirector/internal/client/context_kind.rb +24 -0
  26. data/lib/configdirector/internal/client/evaluated_read.rb +9 -0
  27. data/lib/configdirector/internal/client/event_handlers.rb +114 -0
  28. data/lib/configdirector/internal/client/event_tracking.rb +39 -0
  29. data/lib/configdirector/internal/client/live_client_connections.rb +58 -0
  30. data/lib/configdirector/internal/client/number_of_seconds.rb +21 -0
  31. data/lib/configdirector/internal/client/registrations.rb +43 -0
  32. data/lib/configdirector/internal/client/restart_in_forked_processes.rb +25 -0
  33. data/lib/configdirector/internal/client/served_configs.rb +83 -0
  34. data/lib/configdirector/internal/client/serving_state.rb +102 -0
  35. data/lib/configdirector/internal/client/watches.rb +51 -0
  36. data/lib/configdirector/internal/client/what_follows_a_fork.rb +24 -0
  37. data/lib/configdirector/internal/connection/condition_parser.rb +74 -0
  38. data/lib/configdirector/internal/connection/config_definition.rb +37 -0
  39. data/lib/configdirector/internal/connection/http_session.rb +15 -0
  40. data/lib/configdirector/internal/connection/in_memory_connection.rb +134 -0
  41. data/lib/configdirector/internal/connection/json_post_request.rb +24 -0
  42. data/lib/configdirector/internal/connection/not_a_server_sdk_payload.rb +9 -0
  43. data/lib/configdirector/internal/connection/offline_mode_connection.rb +96 -0
  44. data/lib/configdirector/internal/connection/offline_values_file.rb +49 -0
  45. data/lib/configdirector/internal/connection/payloads_delivered_in_turn.rb +46 -0
  46. data/lib/configdirector/internal/connection/polling_interval.rb +21 -0
  47. data/lib/configdirector/internal/connection/request_deadline.rb +45 -0
  48. data/lib/configdirector/internal/connection/retry_after_header.rb +24 -0
  49. data/lib/configdirector/internal/connection/server_sdk_payload.rb +37 -0
  50. data/lib/configdirector/internal/connection/server_sdk_payload_parser.rb +89 -0
  51. data/lib/configdirector/internal/connection/targeting_rules_parser.rb +70 -0
  52. data/lib/configdirector/internal/connection/test_client_initializations.rb +111 -0
  53. data/lib/configdirector/internal/connection/test_client_values.rb +53 -0
  54. data/lib/configdirector/internal/connection/unreadable_definition.rb +9 -0
  55. data/lib/configdirector/internal/connection/wire_fields.rb +59 -0
  56. data/lib/configdirector/internal/evaluation/array_comparison.rb +25 -0
  57. data/lib/configdirector/internal/evaluation/assigned_percentage.rb +21 -0
  58. data/lib/configdirector/internal/evaluation/attribute_condition.rb +48 -0
  59. data/lib/configdirector/internal/evaluation/config_evaluator.rb +29 -0
  60. data/lib/configdirector/internal/evaluation/datetime_comparison.rb +93 -0
  61. data/lib/configdirector/internal/evaluation/evaluation_context.rb +17 -0
  62. data/lib/configdirector/internal/evaluation/number_comparison.rb +119 -0
  63. data/lib/configdirector/internal/evaluation/rapidhash.rb +124 -0
  64. data/lib/configdirector/internal/evaluation/rollout_share.rb +9 -0
  65. data/lib/configdirector/internal/evaluation/rule.rb +70 -0
  66. data/lib/configdirector/internal/evaluation/scalar_text.rb +70 -0
  67. data/lib/configdirector/internal/evaluation/segment.rb +17 -0
  68. data/lib/configdirector/internal/evaluation/segment_condition.rb +26 -0
  69. data/lib/configdirector/internal/evaluation/semver_comparison.rb +49 -0
  70. data/lib/configdirector/internal/evaluation/served_value.rb +9 -0
  71. data/lib/configdirector/internal/evaluation/share.rb +9 -0
  72. data/lib/configdirector/internal/evaluation/targeting_rules.rb +18 -0
  73. data/lib/configdirector/internal/evaluation/text_comparison.rb +32 -0
  74. data/lib/configdirector/internal/evaluation/trait_pointer.rb +42 -0
  75. data/lib/configdirector/internal/evaluation.rb +21 -0
  76. data/lib/configdirector/internal/identity/sdk_identity.rb +39 -0
  77. data/lib/configdirector/internal/identity/wrapper.rb +48 -0
  78. data/lib/configdirector/internal/logging/client_log.rb +37 -0
  79. data/lib/configdirector/internal/logging/default_logger.rb +34 -0
  80. data/lib/configdirector/internal/polling/poll_answer.rb +111 -0
  81. data/lib/configdirector/internal/polling/poll_request.rb +106 -0
  82. data/lib/configdirector/internal/polling/poll_timing.rb +25 -0
  83. data/lib/configdirector/internal/polling/polling_endpoint.rb +36 -0
  84. data/lib/configdirector/internal/polling/polling_mode_connection.rb +53 -0
  85. data/lib/configdirector/internal/polling/polling_session.rb +99 -0
  86. data/lib/configdirector/internal/polling/polling_transport.rb +74 -0
  87. data/lib/configdirector/internal/polling/refusal_detail.rb +36 -0
  88. data/lib/configdirector/internal/server_sent_events/event_stream_limit_exceeded.rb +9 -0
  89. data/lib/configdirector/internal/server_sent_events/event_stream_parser.rb +95 -0
  90. data/lib/configdirector/internal/server_sent_events/server_sent_event.rb +9 -0
  91. data/lib/configdirector/internal/stoppable_thread.rb +69 -0
  92. data/lib/configdirector/internal/streaming/heartbeats.rb +51 -0
  93. data/lib/configdirector/internal/streaming/reconnecting_stream.rb +82 -0
  94. data/lib/configdirector/internal/streaming/reconnection_delay.rb +29 -0
  95. data/lib/configdirector/internal/streaming/stream_connection.rb +86 -0
  96. data/lib/configdirector/internal/streaming/stream_end.rb +69 -0
  97. data/lib/configdirector/internal/streaming/stream_endpoint.rb +43 -0
  98. data/lib/configdirector/internal/streaming/stream_timing.rb +33 -0
  99. data/lib/configdirector/internal/streaming/streaming_mode_connection.rb +60 -0
  100. data/lib/configdirector/internal/streaming/streaming_transport.rb +42 -0
  101. data/lib/configdirector/internal/telemetry/aggregated_wire_entries.rb +26 -0
  102. data/lib/configdirector/internal/telemetry/collected_telemetry.rb +98 -0
  103. data/lib/configdirector/internal/telemetry/compact_json_text.rb +64 -0
  104. data/lib/configdirector/internal/telemetry/discarded_telemetry.rb +31 -0
  105. data/lib/configdirector/internal/telemetry/event_reporter.rb +47 -0
  106. data/lib/configdirector/internal/telemetry/invalid_context_submissions.rb +76 -0
  107. data/lib/configdirector/internal/telemetry/report_answer.rb +31 -0
  108. data/lib/configdirector/internal/telemetry/report_schedule.rb +66 -0
  109. data/lib/configdirector/internal/telemetry/report_timing.rb +20 -0
  110. data/lib/configdirector/internal/telemetry/reported_context.rb +28 -0
  111. data/lib/configdirector/internal/telemetry/reported_details.rb +71 -0
  112. data/lib/configdirector/internal/telemetry/reported_evaluation.rb +82 -0
  113. data/lib/configdirector/internal/telemetry/reported_telemetry.rb +127 -0
  114. data/lib/configdirector/internal/telemetry/reported_text.rb +13 -0
  115. data/lib/configdirector/internal/telemetry/reported_time.rb +13 -0
  116. data/lib/configdirector/internal/telemetry/reported_value.rb +35 -0
  117. data/lib/configdirector/internal/telemetry/telemetry_endpoint.rb +54 -0
  118. data/lib/configdirector/internal/telemetry/telemetry_report.rb +50 -0
  119. data/lib/configdirector/internal/telemetry/test_client_telemetry.rb +37 -0
  120. data/lib/configdirector/internal/telemetry/tracked_event_admission.rb +72 -0
  121. data/lib/configdirector/internal/telemetry/tracked_event_entry.rb +27 -0
  122. data/lib/configdirector/internal/telemetry/tracked_event_queue.rb +47 -0
  123. data/lib/configdirector/internal/telemetry/tracked_event_warning.rb +28 -0
  124. data/lib/configdirector/internal/telemetry/value_id.rb +23 -0
  125. data/lib/configdirector/internal/telemetry/written_json.rb +9 -0
  126. data/lib/configdirector/internal/unchangeable_copy.rb +38 -0
  127. data/lib/configdirector/internal/value/encoded_native_value.rb +45 -0
  128. data/lib/configdirector/internal/value/hash_keys.rb +34 -0
  129. data/lib/configdirector/internal/value/in_code_default_value.rb +33 -0
  130. data/lib/configdirector/internal/value/json_contents.rb +81 -0
  131. data/lib/configdirector/internal/value/json_position.rb +27 -0
  132. data/lib/configdirector/internal/value/native_values.rb +41 -0
  133. data/lib/configdirector/internal/value/parsed_json.rb +79 -0
  134. data/lib/configdirector/internal/value/plain_decimal_text.rb +36 -0
  135. data/lib/configdirector/internal/value/served_text.rb +76 -0
  136. data/lib/configdirector/internal/value/typed_value.rb +9 -0
  137. data/lib/configdirector/internal/value/unservable_value.rb +9 -0
  138. data/lib/configdirector/internal/value/utf8_text.rb +19 -0
  139. data/lib/configdirector/internal.rb +9 -0
  140. data/lib/configdirector/metadata.rb +26 -0
  141. data/lib/configdirector/subscription.rb +34 -0
  142. data/lib/configdirector/telemetry_options.rb +28 -0
  143. data/lib/configdirector/testing/test_client.rb +122 -0
  144. data/lib/configdirector/testing/tracked_event.rb +46 -0
  145. data/lib/configdirector/testing.rb +44 -0
  146. data/lib/configdirector/variation.rb +21 -0
  147. data/lib/configdirector/version.rb +7 -0
  148. data/lib/configdirector-server-sdk.rb +3 -0
  149. data/lib/configdirector.rb +164 -0
  150. data/sig/configdirector/internal/client.rbs +518 -0
  151. data/sig/configdirector/internal/connection.rbs +389 -0
  152. data/sig/configdirector/internal/evaluation.rbs +364 -0
  153. data/sig/configdirector/internal/identity.rbs +51 -0
  154. data/sig/configdirector/internal/logging.rbs +33 -0
  155. data/sig/configdirector/internal/polling.rbs +240 -0
  156. data/sig/configdirector/internal/server_sent_events.rbs +51 -0
  157. data/sig/configdirector/internal/streaming.rbs +266 -0
  158. data/sig/configdirector/internal/telemetry.rbs +556 -0
  159. data/sig/configdirector/internal/value.rbs +159 -0
  160. data/sig/configdirector/testing.rbs +70 -0
  161. data/sig/configdirector.rbs +465 -0
  162. metadata +231 -0
@@ -0,0 +1,51 @@
1
+ module ConfigDirector
2
+ module Internal
3
+ module ServerSentEvents
4
+ class ServerSentEvent < Data
5
+ attr_reader type: String
6
+ attr_reader data: String
7
+
8
+ def self.new: (type: String, data: String) -> instance
9
+ end
10
+
11
+ class EventStreamLimitExceeded < ConfigDirectorError
12
+ end
13
+
14
+ class EventStreamParser
15
+ MAXIMUM_LINE_BYTES: Integer
16
+ MAXIMUM_EVENT_DATA_BYTES: Integer
17
+ LINE_END: Regexp
18
+ BYTE_ORDER_MARK: String
19
+ ASCII_DIGITS: Regexp
20
+
21
+ @on_event: ^(ServerSentEvent event) -> void
22
+ @at_the_start_of_the_stream: bool
23
+ @unfinished_line: String
24
+ @last_chunk_ended_on_a_carriage_return: bool
25
+ @event_type: String
26
+ @event_data: String
27
+
28
+ attr_reader last_event_id: String
29
+ attr_reader retry_milliseconds: Integer?
30
+
31
+ def initialize: (last_event_id: String) { (ServerSentEvent event) -> void } -> void
32
+
33
+ def feed: (String chunk) -> void
34
+
35
+ private
36
+
37
+ def extend_unfinished_line: (String fragment) -> void
38
+
39
+ def finish_line: (String fragment) -> void
40
+
41
+ def read_line: (String line) -> void
42
+
43
+ def read_field: (String name, String value) -> void
44
+
45
+ def append_data: (String value) -> void
46
+
47
+ def dispatch_event: () -> void
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,266 @@
1
+ module ConfigDirector
2
+ module Internal
3
+ class StoppableThread
4
+ class Stopped < Exception
5
+ end
6
+
7
+ ID_OF_THE_PROCESS_THAT_STARTED_THE_THREAD: Symbol
8
+ ASKED_ITSELF_TO_STOP: Symbol
9
+
10
+ @thread: Thread
11
+
12
+ def self.start: (String name) { () -> void } -> StoppableThread
13
+
14
+ def self.stoppable: [T] () { () -> T } -> T
15
+
16
+ def self.unstoppable: [T] () { () -> T } -> T
17
+
18
+ def self.stop_here_if_asked_to: () -> void
19
+
20
+ private def self.stop_here_when_the_thread_must_end: () -> void
21
+
22
+ private def self.copied_by_a_forked_process?: () -> bool
23
+
24
+ def initialize: (Thread thread) -> void
25
+
26
+ def stop: () -> void
27
+
28
+ def join_within: (seconds seconds) -> void
29
+ end
30
+
31
+ module Streaming
32
+ class StreamTiming < Data
33
+ attr_reader seconds_between_heartbeats: seconds
34
+ attr_reader seconds_of_silence_of_a_dropped_stream: seconds
35
+ attr_reader seconds_to_open_a_stream: seconds
36
+ attr_reader pause_before_reconnecting: ^(seconds seconds) -> void
37
+ attr_reader random_fraction: ^() -> Float
38
+
39
+ def self.new: (
40
+ seconds_between_heartbeats: seconds,
41
+ seconds_of_silence_of_a_dropped_stream: seconds,
42
+ seconds_to_open_a_stream: seconds,
43
+ pause_before_reconnecting: ^(seconds seconds) -> void,
44
+ random_fraction: ^() -> Float
45
+ ) -> instance
46
+
47
+ def self.of_the_protocol: () -> StreamTiming
48
+
49
+ def deadline_of_a_heartbeat: () -> Connection::RequestDeadline
50
+ end
51
+
52
+ class StreamEndpoint
53
+ @stream_uri: URI::Generic
54
+ @heartbeat_uri: URI::Generic
55
+ @server_sdk_key: String
56
+ @sdk_identity: Identity::SdkIdentity
57
+ @meta_context: Hash[Symbol, String]
58
+
59
+ def initialize: (
60
+ url: String,
61
+ server_sdk_key: String,
62
+ metadata: Metadata,
63
+ sdk_identity: Identity::SdkIdentity
64
+ ) -> void
65
+
66
+ def http_session: (StreamTiming timing) -> Net::HTTP
67
+
68
+ def stream_request: (session_id: String, last_event_id: String) -> Net::HTTP::Post
69
+
70
+ def heartbeat_request: (session_id: String) -> Net::HTTP::Post
71
+ end
72
+
73
+ module ReconnectionDelay
74
+ MAXIMUM_BACKOFF_EXPONENT: Integer
75
+ SHORTEST_WAIT_THE_SERVER_CAN_ASK_FOR_SECONDS: Integer
76
+ LONGEST_WAIT_THE_SERVER_CAN_ASK_FOR_SECONDS: Integer
77
+
78
+ def self.seconds_before_attempt: (
79
+ Integer attempt,
80
+ seconds_the_server_asked_to_wait: seconds?,
81
+ random_fraction: Float
82
+ ) -> seconds
83
+ end
84
+
85
+ type stream_end_kind = :unreachable
86
+ | :refused
87
+ | :throttled
88
+ | :dropped
89
+ | :refused_unrecoverably
90
+ | :ended_without_content
91
+
92
+ class StreamEnd < Data
93
+ WHAT_FOLLOWS_BY_KIND: Hash[Symbol, Symbol]
94
+ SUCCESS_STATUSES: Range[Integer]
95
+ NO_CONTENT_STATUS: Integer
96
+ TOO_MANY_REQUESTS_STATUS: Integer
97
+ CLIENT_ERROR_STATUSES: Range[Integer]
98
+ MILLISECONDS_PER_SECOND: Float
99
+
100
+ attr_reader kind: stream_end_kind
101
+ attr_reader cause: String
102
+ attr_reader status: Integer?
103
+ attr_reader seconds_the_server_asked_to_wait: seconds?
104
+ attr_reader last_event_id: String
105
+
106
+ def self.new: (
107
+ kind: stream_end_kind,
108
+ cause: String,
109
+ status: Integer?,
110
+ seconds_the_server_asked_to_wait: seconds?,
111
+ last_event_id: String
112
+ ) -> instance
113
+
114
+ def self.stream_opened_by?: (Integer status) -> bool
115
+
116
+ def self.unreachable: (String cause, last_event_id: String) -> StreamEnd
117
+
118
+ def self.dropped: (String cause, milliseconds_named_by_the_stream: Integer?, last_event_id: String) -> StreamEnd
119
+
120
+ def self.answered_without_a_stream: (
121
+ Integer status,
122
+ seconds_named_by_retry_after: seconds?,
123
+ last_event_id: String
124
+ ) -> StreamEnd
125
+
126
+ private def self.without_a_stream: (
127
+ stream_end_kind kind,
128
+ Integer status,
129
+ String last_event_id,
130
+ ?seconds? seconds_the_server_asked_to_wait
131
+ ) -> StreamEnd
132
+
133
+ def what_follows: () -> Symbol
134
+ end
135
+
136
+ class StreamConnection
137
+ @endpoint: StreamEndpoint
138
+ @timing: StreamTiming
139
+ @process_id_of_the_process_that_streams: Integer
140
+ @last_event_id_sent: String
141
+ @parser: ServerSentEvents::EventStreamParser
142
+ @answer: Net::HTTPResponse?
143
+
144
+ attr_reader session_id: String
145
+
146
+ def initialize: (endpoint: StreamEndpoint, timing: StreamTiming, last_event_id: String) { (String event_data) -> void } -> void
147
+
148
+ def stream_until_it_ends: () { () -> void } -> StreamEnd
149
+
150
+ private
151
+
152
+ def request_the_stream: (^() -> void stream_opened) -> void
153
+
154
+ def read_the_answer_to_the_stream_request: (Net::HTTP http_session, ^() -> void stream_opened) -> void
155
+
156
+ def finish_unless_a_forked_process_copied: (Net::HTTP http_session) -> void
157
+
158
+ def read_the_stream_in: (Net::HTTPResponse response, ^() -> void stream_opened) -> void
159
+
160
+ def stream_end_caused_by: (String cause) -> StreamEnd
161
+
162
+ def dropped_stream_end_caused_by: (String cause) -> StreamEnd
163
+
164
+ def status_of: (Net::HTTPResponse answer) -> Integer
165
+ end
166
+
167
+ class Heartbeats
168
+ @endpoint: StreamEndpoint
169
+ @timing: StreamTiming
170
+ @log: Logging::ClientLog
171
+ @lock: Thread::Mutex
172
+ @session_id_of_the_open_stream: String?
173
+
174
+ def initialize: (endpoint: StreamEndpoint, timing: StreamTiming, log: Logging::ClientLog) -> void
175
+
176
+ def stream_opened: (String session_id) -> void
177
+
178
+ def stream_ended: () -> void
179
+
180
+ def send_on_every_interval: () -> bot
181
+
182
+ private
183
+
184
+ def send_for: (String session_id) -> void
185
+
186
+ def answer_to_a_heartbeat_of: (String session_id) -> Net::HTTPResponse
187
+ end
188
+
189
+ class ReconnectingStream
190
+ ATTEMPTS_LOGGED_AT_INFO: Integer
191
+
192
+ @endpoint: StreamEndpoint
193
+ @timing: StreamTiming
194
+ @heartbeats: Heartbeats
195
+ @log: Logging::ClientLog
196
+ @attempt: Integer
197
+ @last_event_id: String
198
+
199
+ def initialize: (
200
+ endpoint: StreamEndpoint,
201
+ timing: StreamTiming,
202
+ heartbeats: Heartbeats,
203
+ log: Logging::ClientLog
204
+ ) -> void
205
+
206
+ def keep_open: (
207
+ report_unrecoverable_error: ^(ConfigDirectorConnectionError unrecoverable_error) -> void
208
+ ) { (String event_data) -> void } -> void
209
+
210
+ private
211
+
212
+ def stream_until_it_ends: () { (String event_data) -> void } -> StreamEnd
213
+
214
+ def take_note_of_the_open_stream_of: (StreamConnection connection) -> void
215
+
216
+ def deliver: (String event_data) { (String event_data) -> void } -> void
217
+
218
+ def stop_for_good: (
219
+ Integer? status,
220
+ ^(ConfigDirectorConnectionError unrecoverable_error) -> void report_unrecoverable_error
221
+ ) -> void
222
+
223
+ def pause_before_attempt: (Integer attempt, StreamEnd stream_end) -> void
224
+ end
225
+
226
+ class StreamingTransport
227
+ SECONDS_CLOSE_WAITS_FOR_THE_THREADS: Integer
228
+
229
+ @heartbeats: Heartbeats
230
+ @stream: ReconnectingStream
231
+ @lock: Thread::Mutex
232
+ @threads: Array[StoppableThread]
233
+
234
+ def initialize: (endpoint: StreamEndpoint, logger: _Logger & Object, ?timing: StreamTiming) -> void
235
+
236
+ def open: (
237
+ report_unrecoverable_error: ^(ConfigDirectorConnectionError unrecoverable_error) -> void
238
+ ) { (String event_data) -> void } -> void
239
+
240
+ def close: () -> void
241
+ end
242
+
243
+ class StreamingModeConnection
244
+ include Connection::_Connection
245
+ extend Connection::_ConnectionOfAMode
246
+
247
+ @endpoint: StreamEndpoint
248
+ @logger: _Logger & Object
249
+ @log: Logging::ClientLog
250
+ @transport: StreamingTransport
251
+
252
+ def initialize: (StreamEndpoint endpoint, _Logger & Object logger) -> void
253
+
254
+ private
255
+
256
+ def transport_of_a_new_session: () -> StreamingTransport
257
+
258
+ def open_a_stream: (
259
+ report_unrecoverable_error: ^(ConfigDirectorConnectionError unrecoverable_error) -> void
260
+ ) { (Connection::ServerSdkPayload payload) -> void } -> void
261
+
262
+ def payload_or_nothing_in: (String event_data) -> Connection::ServerSdkPayload?
263
+ end
264
+ end
265
+ end
266
+ end