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.
- checksums.yaml +7 -0
- data/.yardopts +2 -0
- data/CHANGELOG.md +254 -0
- data/LICENSE +21 -0
- data/README.md +230 -0
- data/lib/configdirector/client_hooks.rb +46 -0
- data/lib/configdirector/config_director_client.rb +322 -0
- data/lib/configdirector/config_evaluated_event.rb +10 -0
- data/lib/configdirector/config_evaluation.rb +51 -0
- data/lib/configdirector/config_state.rb +39 -0
- data/lib/configdirector/configs_updated_event.rb +23 -0
- data/lib/configdirector/connection_error_event.rb +11 -0
- data/lib/configdirector/connection_options.rb +60 -0
- data/lib/configdirector/context.rb +53 -0
- data/lib/configdirector/errors.rb +29 -0
- data/lib/configdirector/internal/client/client_connection.rb +119 -0
- data/lib/configdirector/internal/client/client_factory.rb +104 -0
- data/lib/configdirector/internal/client/client_options_validation.rb +53 -0
- data/lib/configdirector/internal/client/config_read.rb +31 -0
- data/lib/configdirector/internal/client/config_reader.rb +55 -0
- data/lib/configdirector/internal/client/connection_intake.rb +59 -0
- data/lib/configdirector/internal/client/connection_options_validation.rb +94 -0
- data/lib/configdirector/internal/client/context_admission.rb +48 -0
- data/lib/configdirector/internal/client/context_attributes.rb +78 -0
- data/lib/configdirector/internal/client/context_kind.rb +24 -0
- data/lib/configdirector/internal/client/evaluated_read.rb +9 -0
- data/lib/configdirector/internal/client/event_handlers.rb +114 -0
- data/lib/configdirector/internal/client/event_tracking.rb +39 -0
- data/lib/configdirector/internal/client/live_client_connections.rb +58 -0
- data/lib/configdirector/internal/client/number_of_seconds.rb +21 -0
- data/lib/configdirector/internal/client/registrations.rb +43 -0
- data/lib/configdirector/internal/client/restart_in_forked_processes.rb +25 -0
- data/lib/configdirector/internal/client/served_configs.rb +83 -0
- data/lib/configdirector/internal/client/serving_state.rb +102 -0
- data/lib/configdirector/internal/client/watches.rb +51 -0
- data/lib/configdirector/internal/client/what_follows_a_fork.rb +24 -0
- data/lib/configdirector/internal/connection/condition_parser.rb +74 -0
- data/lib/configdirector/internal/connection/config_definition.rb +37 -0
- data/lib/configdirector/internal/connection/http_session.rb +15 -0
- data/lib/configdirector/internal/connection/in_memory_connection.rb +134 -0
- data/lib/configdirector/internal/connection/json_post_request.rb +24 -0
- data/lib/configdirector/internal/connection/not_a_server_sdk_payload.rb +9 -0
- data/lib/configdirector/internal/connection/offline_mode_connection.rb +96 -0
- data/lib/configdirector/internal/connection/offline_values_file.rb +49 -0
- data/lib/configdirector/internal/connection/payloads_delivered_in_turn.rb +46 -0
- data/lib/configdirector/internal/connection/polling_interval.rb +21 -0
- data/lib/configdirector/internal/connection/request_deadline.rb +45 -0
- data/lib/configdirector/internal/connection/retry_after_header.rb +24 -0
- data/lib/configdirector/internal/connection/server_sdk_payload.rb +37 -0
- data/lib/configdirector/internal/connection/server_sdk_payload_parser.rb +89 -0
- data/lib/configdirector/internal/connection/targeting_rules_parser.rb +70 -0
- data/lib/configdirector/internal/connection/test_client_initializations.rb +111 -0
- data/lib/configdirector/internal/connection/test_client_values.rb +53 -0
- data/lib/configdirector/internal/connection/unreadable_definition.rb +9 -0
- data/lib/configdirector/internal/connection/wire_fields.rb +59 -0
- data/lib/configdirector/internal/evaluation/array_comparison.rb +25 -0
- data/lib/configdirector/internal/evaluation/assigned_percentage.rb +21 -0
- data/lib/configdirector/internal/evaluation/attribute_condition.rb +48 -0
- data/lib/configdirector/internal/evaluation/config_evaluator.rb +29 -0
- data/lib/configdirector/internal/evaluation/datetime_comparison.rb +93 -0
- data/lib/configdirector/internal/evaluation/evaluation_context.rb +17 -0
- data/lib/configdirector/internal/evaluation/number_comparison.rb +119 -0
- data/lib/configdirector/internal/evaluation/rapidhash.rb +124 -0
- data/lib/configdirector/internal/evaluation/rollout_share.rb +9 -0
- data/lib/configdirector/internal/evaluation/rule.rb +70 -0
- data/lib/configdirector/internal/evaluation/scalar_text.rb +70 -0
- data/lib/configdirector/internal/evaluation/segment.rb +17 -0
- data/lib/configdirector/internal/evaluation/segment_condition.rb +26 -0
- data/lib/configdirector/internal/evaluation/semver_comparison.rb +49 -0
- data/lib/configdirector/internal/evaluation/served_value.rb +9 -0
- data/lib/configdirector/internal/evaluation/share.rb +9 -0
- data/lib/configdirector/internal/evaluation/targeting_rules.rb +18 -0
- data/lib/configdirector/internal/evaluation/text_comparison.rb +32 -0
- data/lib/configdirector/internal/evaluation/trait_pointer.rb +42 -0
- data/lib/configdirector/internal/evaluation.rb +21 -0
- data/lib/configdirector/internal/identity/sdk_identity.rb +39 -0
- data/lib/configdirector/internal/identity/wrapper.rb +48 -0
- data/lib/configdirector/internal/logging/client_log.rb +37 -0
- data/lib/configdirector/internal/logging/default_logger.rb +34 -0
- data/lib/configdirector/internal/polling/poll_answer.rb +111 -0
- data/lib/configdirector/internal/polling/poll_request.rb +106 -0
- data/lib/configdirector/internal/polling/poll_timing.rb +25 -0
- data/lib/configdirector/internal/polling/polling_endpoint.rb +36 -0
- data/lib/configdirector/internal/polling/polling_mode_connection.rb +53 -0
- data/lib/configdirector/internal/polling/polling_session.rb +99 -0
- data/lib/configdirector/internal/polling/polling_transport.rb +74 -0
- data/lib/configdirector/internal/polling/refusal_detail.rb +36 -0
- data/lib/configdirector/internal/server_sent_events/event_stream_limit_exceeded.rb +9 -0
- data/lib/configdirector/internal/server_sent_events/event_stream_parser.rb +95 -0
- data/lib/configdirector/internal/server_sent_events/server_sent_event.rb +9 -0
- data/lib/configdirector/internal/stoppable_thread.rb +69 -0
- data/lib/configdirector/internal/streaming/heartbeats.rb +51 -0
- data/lib/configdirector/internal/streaming/reconnecting_stream.rb +82 -0
- data/lib/configdirector/internal/streaming/reconnection_delay.rb +29 -0
- data/lib/configdirector/internal/streaming/stream_connection.rb +86 -0
- data/lib/configdirector/internal/streaming/stream_end.rb +69 -0
- data/lib/configdirector/internal/streaming/stream_endpoint.rb +43 -0
- data/lib/configdirector/internal/streaming/stream_timing.rb +33 -0
- data/lib/configdirector/internal/streaming/streaming_mode_connection.rb +60 -0
- data/lib/configdirector/internal/streaming/streaming_transport.rb +42 -0
- data/lib/configdirector/internal/telemetry/aggregated_wire_entries.rb +26 -0
- data/lib/configdirector/internal/telemetry/collected_telemetry.rb +98 -0
- data/lib/configdirector/internal/telemetry/compact_json_text.rb +64 -0
- data/lib/configdirector/internal/telemetry/discarded_telemetry.rb +31 -0
- data/lib/configdirector/internal/telemetry/event_reporter.rb +47 -0
- data/lib/configdirector/internal/telemetry/invalid_context_submissions.rb +76 -0
- data/lib/configdirector/internal/telemetry/report_answer.rb +31 -0
- data/lib/configdirector/internal/telemetry/report_schedule.rb +66 -0
- data/lib/configdirector/internal/telemetry/report_timing.rb +20 -0
- data/lib/configdirector/internal/telemetry/reported_context.rb +28 -0
- data/lib/configdirector/internal/telemetry/reported_details.rb +71 -0
- data/lib/configdirector/internal/telemetry/reported_evaluation.rb +82 -0
- data/lib/configdirector/internal/telemetry/reported_telemetry.rb +127 -0
- data/lib/configdirector/internal/telemetry/reported_text.rb +13 -0
- data/lib/configdirector/internal/telemetry/reported_time.rb +13 -0
- data/lib/configdirector/internal/telemetry/reported_value.rb +35 -0
- data/lib/configdirector/internal/telemetry/telemetry_endpoint.rb +54 -0
- data/lib/configdirector/internal/telemetry/telemetry_report.rb +50 -0
- data/lib/configdirector/internal/telemetry/test_client_telemetry.rb +37 -0
- data/lib/configdirector/internal/telemetry/tracked_event_admission.rb +72 -0
- data/lib/configdirector/internal/telemetry/tracked_event_entry.rb +27 -0
- data/lib/configdirector/internal/telemetry/tracked_event_queue.rb +47 -0
- data/lib/configdirector/internal/telemetry/tracked_event_warning.rb +28 -0
- data/lib/configdirector/internal/telemetry/value_id.rb +23 -0
- data/lib/configdirector/internal/telemetry/written_json.rb +9 -0
- data/lib/configdirector/internal/unchangeable_copy.rb +38 -0
- data/lib/configdirector/internal/value/encoded_native_value.rb +45 -0
- data/lib/configdirector/internal/value/hash_keys.rb +34 -0
- data/lib/configdirector/internal/value/in_code_default_value.rb +33 -0
- data/lib/configdirector/internal/value/json_contents.rb +81 -0
- data/lib/configdirector/internal/value/json_position.rb +27 -0
- data/lib/configdirector/internal/value/native_values.rb +41 -0
- data/lib/configdirector/internal/value/parsed_json.rb +79 -0
- data/lib/configdirector/internal/value/plain_decimal_text.rb +36 -0
- data/lib/configdirector/internal/value/served_text.rb +76 -0
- data/lib/configdirector/internal/value/typed_value.rb +9 -0
- data/lib/configdirector/internal/value/unservable_value.rb +9 -0
- data/lib/configdirector/internal/value/utf8_text.rb +19 -0
- data/lib/configdirector/internal.rb +9 -0
- data/lib/configdirector/metadata.rb +26 -0
- data/lib/configdirector/subscription.rb +34 -0
- data/lib/configdirector/telemetry_options.rb +28 -0
- data/lib/configdirector/testing/test_client.rb +122 -0
- data/lib/configdirector/testing/tracked_event.rb +46 -0
- data/lib/configdirector/testing.rb +44 -0
- data/lib/configdirector/variation.rb +21 -0
- data/lib/configdirector/version.rb +7 -0
- data/lib/configdirector-server-sdk.rb +3 -0
- data/lib/configdirector.rb +164 -0
- data/sig/configdirector/internal/client.rbs +518 -0
- data/sig/configdirector/internal/connection.rbs +389 -0
- data/sig/configdirector/internal/evaluation.rbs +364 -0
- data/sig/configdirector/internal/identity.rbs +51 -0
- data/sig/configdirector/internal/logging.rbs +33 -0
- data/sig/configdirector/internal/polling.rbs +240 -0
- data/sig/configdirector/internal/server_sent_events.rbs +51 -0
- data/sig/configdirector/internal/streaming.rbs +266 -0
- data/sig/configdirector/internal/telemetry.rbs +556 -0
- data/sig/configdirector/internal/value.rbs +159 -0
- data/sig/configdirector/testing.rbs +70 -0
- data/sig/configdirector.rbs +465 -0
- metadata +231 -0
|
@@ -0,0 +1,556 @@
|
|
|
1
|
+
module ConfigDirector
|
|
2
|
+
module Internal
|
|
3
|
+
module Telemetry
|
|
4
|
+
type wire_event = Hash[Symbol, untyped]
|
|
5
|
+
|
|
6
|
+
type report_answer_kind = :accepted | :refused | :refused_unrecoverably | :unanswered
|
|
7
|
+
|
|
8
|
+
type invalid_context_recording = :new_kind_sample
|
|
9
|
+
| :known_kind_sample
|
|
10
|
+
| :first_beyond_sample_limit
|
|
11
|
+
| :beyond_sample_limit
|
|
12
|
+
|
|
13
|
+
type tracked_event_admission = AdmittedTrackedEvent | DroppedTrackedEvent
|
|
14
|
+
|
|
15
|
+
type tracked_event_warning = :name_outside_the_character_limit
|
|
16
|
+
| :value_not_a_finite_number
|
|
17
|
+
| :details_not_reportable
|
|
18
|
+
| :batch_already_full
|
|
19
|
+
|
|
20
|
+
interface _ClientTelemetry
|
|
21
|
+
def record_evaluation: (Client::EvaluatedRead evaluated_read) -> void
|
|
22
|
+
|
|
23
|
+
def record_tracked_event: (tracked_event_admission admission) -> Array[String]
|
|
24
|
+
|
|
25
|
+
def count_invalid_context: (String kind_sample) -> invalid_context_recording
|
|
26
|
+
|
|
27
|
+
def start_reporting: () -> void
|
|
28
|
+
|
|
29
|
+
def choose_the_reporter_of_what_the_parent_process_collected: (Symbol forked_through) -> void
|
|
30
|
+
|
|
31
|
+
def restart_in_a_forked_process: () -> void
|
|
32
|
+
|
|
33
|
+
def close: () -> void
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
interface _TelemetryOfAMode
|
|
37
|
+
def for_a_client_with: (
|
|
38
|
+
server_sdk_key: String,
|
|
39
|
+
metadata: Metadata,
|
|
40
|
+
connection_options: ConnectionOptions,
|
|
41
|
+
telemetry_options: TelemetryOptions,
|
|
42
|
+
sdk_identity: Identity::SdkIdentity,
|
|
43
|
+
logger: _Logger & Object
|
|
44
|
+
) -> _ClientTelemetry
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
module ValueId
|
|
48
|
+
DIGEST_BYTES: Integer
|
|
49
|
+
BASE62_DIGITS: String
|
|
50
|
+
LENGTH: Integer
|
|
51
|
+
|
|
52
|
+
def self.of: (String text) -> String
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
module ReportedText
|
|
56
|
+
def self.of: (String text) -> String
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
class WrittenJson < Data
|
|
60
|
+
attr_reader text: String
|
|
61
|
+
|
|
62
|
+
def self.new: (text: String) -> instance
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
module CompactJsonText
|
|
66
|
+
MOST_LEVELS_WRITTEN: Integer
|
|
67
|
+
|
|
68
|
+
def self.of: (untyped value) -> String
|
|
69
|
+
|
|
70
|
+
def self.number_javascript_holds?: (Integer | Float number) -> bool
|
|
71
|
+
|
|
72
|
+
private def self.text_inside: (untyped value, Array[Array[untyped] | Hash[untyped, untyped]] containers_around_it) -> String
|
|
73
|
+
|
|
74
|
+
private def self.number_text_of: (Integer | Float number) -> String
|
|
75
|
+
|
|
76
|
+
private def self.container_text_inside: (
|
|
77
|
+
Array[untyped] | Hash[untyped, untyped] container,
|
|
78
|
+
Array[Array[untyped] | Hash[untyped, untyped]] containers_around_it
|
|
79
|
+
) -> String
|
|
80
|
+
|
|
81
|
+
private def self.element_texts_of: (
|
|
82
|
+
Array[untyped] array,
|
|
83
|
+
Array[Array[untyped] | Hash[untyped, untyped]] containers_around_its_contents
|
|
84
|
+
) -> Array[String]
|
|
85
|
+
|
|
86
|
+
private def self.member_texts_of: (
|
|
87
|
+
Hash[untyped, untyped] hash,
|
|
88
|
+
Array[Array[untyped] | Hash[untyped, untyped]] containers_around_its_contents
|
|
89
|
+
) -> Array[String]
|
|
90
|
+
|
|
91
|
+
private def self.string_text_of: (String text) -> String
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
module ReportedValue
|
|
95
|
+
MAXIMUM_CHARACTERS_REPORTED_AS_TEXT: Integer
|
|
96
|
+
JSON_CONFIG_TYPE: String
|
|
97
|
+
|
|
98
|
+
def self.reported_by_the_value_id_sent_with_it?: (
|
|
99
|
+
config_value value,
|
|
100
|
+
String? config_type,
|
|
101
|
+
String? value_id_sent_with_the_value
|
|
102
|
+
) -> bool
|
|
103
|
+
|
|
104
|
+
def self.of: (config_value value, String? config_type) -> Hash[Symbol, String]
|
|
105
|
+
|
|
106
|
+
private def self.json_value?: (config_value value, String? config_type) -> bool
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
module ReportedTime
|
|
110
|
+
def self.of: (Time time) -> String
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
module AggregatedWireEntries
|
|
114
|
+
LARGEST_COUNT_THE_SDK_SERVER_READS: Integer
|
|
115
|
+
|
|
116
|
+
def self.count_the_sdk_server_reads: (Integer count) -> Integer
|
|
117
|
+
|
|
118
|
+
def self.of: (
|
|
119
|
+
Hash[wire_event, Integer] counts_by_wire_event,
|
|
120
|
+
counted_since: Time?,
|
|
121
|
+
counted_until: Time
|
|
122
|
+
) -> Array[wire_event]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
class ReportedContext < Data
|
|
126
|
+
KIND_OF_A_CONTEXT_WITHOUT_ONE: String
|
|
127
|
+
|
|
128
|
+
attr_reader kind: String
|
|
129
|
+
attr_reader identifier: String
|
|
130
|
+
attr_reader context: Context
|
|
131
|
+
|
|
132
|
+
def self.new: (kind: String, identifier: String, context: Context) -> instance
|
|
133
|
+
|
|
134
|
+
def self.of: (Context? context) -> ReportedContext?
|
|
135
|
+
|
|
136
|
+
def wire_context: () -> Hash[Symbol, untyped]
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
class ReportedEvaluation < Data
|
|
140
|
+
REQUESTED_TYPE_BY_IN_CODE_DEFAULT_VALUE_KIND: Hash[Symbol, String]
|
|
141
|
+
|
|
142
|
+
attr_reader config_read: Client::ConfigRead
|
|
143
|
+
attr_reader config_state: ConfigState?
|
|
144
|
+
attr_reader returned_the_in_code_default_value: bool
|
|
145
|
+
attr_reader reason: String
|
|
146
|
+
attr_reader value_kept_for_the_report: config_value?
|
|
147
|
+
|
|
148
|
+
def self.new: (
|
|
149
|
+
config_read: Client::ConfigRead,
|
|
150
|
+
config_state: ConfigState?,
|
|
151
|
+
returned_the_in_code_default_value: bool,
|
|
152
|
+
reason: String,
|
|
153
|
+
value_kept_for_the_report: config_value?
|
|
154
|
+
) -> instance
|
|
155
|
+
|
|
156
|
+
def self.of: (Client::EvaluatedRead evaluated_read) -> ReportedEvaluation
|
|
157
|
+
|
|
158
|
+
def wire_event: () -> wire_event
|
|
159
|
+
|
|
160
|
+
private
|
|
161
|
+
|
|
162
|
+
def wire_context: () -> wire_event
|
|
163
|
+
|
|
164
|
+
def wire_evaluation: () -> wire_event
|
|
165
|
+
|
|
166
|
+
def wire_evaluated_value: () -> Hash[Symbol, String?]
|
|
167
|
+
|
|
168
|
+
def wire_identifiers_of_what_was_served: () -> wire_event
|
|
169
|
+
|
|
170
|
+
def config_state_served: () -> ConfigState?
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
class InvalidContextSubmissions
|
|
174
|
+
DISTINCT_KIND_SAMPLE_LIMIT: Integer
|
|
175
|
+
REASON: String
|
|
176
|
+
|
|
177
|
+
@counts_by_kind_sample: Hash[String, Integer]
|
|
178
|
+
@count_beyond_the_sample_limit: Integer
|
|
179
|
+
@counted_since: Time?
|
|
180
|
+
|
|
181
|
+
def initialize: () -> void
|
|
182
|
+
|
|
183
|
+
def count: (String kind_sample, Time now) -> invalid_context_recording
|
|
184
|
+
|
|
185
|
+
def wire_entries_taken_for_a_report: (Time now) -> Array[wire_event]
|
|
186
|
+
|
|
187
|
+
def discard: () -> void
|
|
188
|
+
|
|
189
|
+
private
|
|
190
|
+
|
|
191
|
+
def count_known: (String kind_sample) -> :known_kind_sample
|
|
192
|
+
|
|
193
|
+
def count_new: (String kind_sample) -> :new_kind_sample
|
|
194
|
+
|
|
195
|
+
def count_beyond_the_sample_limit: () -> (:first_beyond_sample_limit | :beyond_sample_limit)
|
|
196
|
+
|
|
197
|
+
def counts_by_wire_event: () -> Hash[wire_event, Integer]
|
|
198
|
+
|
|
199
|
+
def wire_event_of: (String? kind_sample) -> wire_event
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
class ReportedDetails
|
|
203
|
+
MOST_TOP_LEVEL_KEYS: Integer
|
|
204
|
+
MOST_JSON_BYTES: Integer
|
|
205
|
+
MOST_VALUES_THE_JSON_BYTES_HOLD: Integer
|
|
206
|
+
|
|
207
|
+
@values_left: Integer
|
|
208
|
+
|
|
209
|
+
def self.json_of: (untyped details) -> WrittenJson?
|
|
210
|
+
|
|
211
|
+
private def self.new: () -> instance
|
|
212
|
+
|
|
213
|
+
def initialize: () -> void
|
|
214
|
+
|
|
215
|
+
def reported_form_of: (Hash[untyped, untyped] details) -> Hash[String, untyped]?
|
|
216
|
+
|
|
217
|
+
private
|
|
218
|
+
|
|
219
|
+
def form_of: (untyped value, Integer level) -> untyped
|
|
220
|
+
|
|
221
|
+
def count_one_more_value: () -> void
|
|
222
|
+
|
|
223
|
+
def container_form_of: (
|
|
224
|
+
Array[untyped] | Hash[untyped, untyped] container,
|
|
225
|
+
Integer level
|
|
226
|
+
) -> (Array[untyped] | Hash[String, untyped])
|
|
227
|
+
|
|
228
|
+
def name_of: (untyped key) -> String
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
class TrackedEventEntry < Data
|
|
232
|
+
attr_reader name: String
|
|
233
|
+
attr_reader context_kind: String?
|
|
234
|
+
attr_reader context_identifier: String?
|
|
235
|
+
attr_reader value: (Integer | Float)?
|
|
236
|
+
attr_reader details: WrittenJson?
|
|
237
|
+
attr_reader happened_at: Time
|
|
238
|
+
|
|
239
|
+
def self.new: (
|
|
240
|
+
name: String,
|
|
241
|
+
context_kind: String?,
|
|
242
|
+
context_identifier: String?,
|
|
243
|
+
value: (Integer | Float)?,
|
|
244
|
+
details: WrittenJson?,
|
|
245
|
+
happened_at: Time
|
|
246
|
+
) -> instance
|
|
247
|
+
|
|
248
|
+
def self.of: (
|
|
249
|
+
name: String,
|
|
250
|
+
context: Context?,
|
|
251
|
+
value: (Integer | Float)?,
|
|
252
|
+
details: WrittenJson?,
|
|
253
|
+
happened_at: Time
|
|
254
|
+
) -> TrackedEventEntry
|
|
255
|
+
|
|
256
|
+
def wire_entry: () -> Hash[Symbol, untyped]
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
class AdmittedTrackedEvent < Data
|
|
260
|
+
attr_reader entry: TrackedEventEntry
|
|
261
|
+
attr_reader context: Context?
|
|
262
|
+
attr_reader warnings: Array[tracked_event_warning]
|
|
263
|
+
|
|
264
|
+
def self.new: (entry: TrackedEventEntry, context: Context?, warnings: Array[tracked_event_warning]) -> instance
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
class DroppedTrackedEvent < Data
|
|
268
|
+
attr_reader warnings: Array[tracked_event_warning]
|
|
269
|
+
|
|
270
|
+
def self.new: (warnings: Array[tracked_event_warning]) -> instance
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
module TrackedEventAdmission
|
|
274
|
+
NAME_MAXIMUM_CHARACTERS: Integer
|
|
275
|
+
|
|
276
|
+
class ReportedPart[T] < Data
|
|
277
|
+
attr_reader reported: T?
|
|
278
|
+
attr_reader warnings: Array[tracked_event_warning]
|
|
279
|
+
|
|
280
|
+
def self.new: [T] (reported: T?, warnings: Array[tracked_event_warning]) -> ReportedPart[T]
|
|
281
|
+
|
|
282
|
+
def self.not_given: () -> ReportedPart[untyped]
|
|
283
|
+
|
|
284
|
+
def self.of: [T] (T reported) -> ReportedPart[T]
|
|
285
|
+
|
|
286
|
+
def self.left_out_with: (tracked_event_warning warning) -> ReportedPart[untyped]
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
def self.of: (
|
|
290
|
+
name: untyped,
|
|
291
|
+
context: Context?,
|
|
292
|
+
value: untyped,
|
|
293
|
+
details: untyped,
|
|
294
|
+
happened_at: Time
|
|
295
|
+
) -> tracked_event_admission
|
|
296
|
+
|
|
297
|
+
private def self.reported_name_of: (untyped name) -> String?
|
|
298
|
+
|
|
299
|
+
private def self.reported_value_of: (untyped value) -> ReportedPart[Integer | Float]
|
|
300
|
+
|
|
301
|
+
private def self.reported_details_of: (untyped details) -> ReportedPart[WrittenJson]
|
|
302
|
+
end
|
|
303
|
+
|
|
304
|
+
module TrackedEventWarning
|
|
305
|
+
MESSAGE_BY_WARNING: Hash[Symbol, String]
|
|
306
|
+
|
|
307
|
+
def self.message_of: (tracked_event_warning warning) -> String
|
|
308
|
+
end
|
|
309
|
+
|
|
310
|
+
class TrackedEventQueue
|
|
311
|
+
EVENTS_PER_REPORT: Integer
|
|
312
|
+
|
|
313
|
+
@warnings_logged_for_this_report: Set[tracked_event_warning]
|
|
314
|
+
|
|
315
|
+
attr_reader entries: Array[TrackedEventEntry]
|
|
316
|
+
|
|
317
|
+
def initialize: () -> void
|
|
318
|
+
|
|
319
|
+
def add: (tracked_event_admission admission) -> Array[String]
|
|
320
|
+
|
|
321
|
+
def discard: () -> void
|
|
322
|
+
|
|
323
|
+
private
|
|
324
|
+
|
|
325
|
+
def keep: (tracked_event_admission admission) -> Array[tracked_event_warning]
|
|
326
|
+
end
|
|
327
|
+
|
|
328
|
+
class TelemetryReport < Data
|
|
329
|
+
attr_reader evaluations: Array[ReportedEvaluation]
|
|
330
|
+
attr_reader evaluations_collected_since: Time?
|
|
331
|
+
attr_reader evaluations_dropped: Integer
|
|
332
|
+
attr_reader captured_contexts: Array[ReportedContext]
|
|
333
|
+
attr_reader captured_contexts_dropped: Integer
|
|
334
|
+
attr_reader invalid_context_wire_entries: Array[wire_event]
|
|
335
|
+
attr_reader tracked_events: Array[TrackedEventEntry]
|
|
336
|
+
attr_reader taken_at: Time
|
|
337
|
+
|
|
338
|
+
def self.new: (
|
|
339
|
+
evaluations: Array[ReportedEvaluation],
|
|
340
|
+
evaluations_collected_since: Time?,
|
|
341
|
+
evaluations_dropped: Integer,
|
|
342
|
+
captured_contexts: Array[ReportedContext],
|
|
343
|
+
captured_contexts_dropped: Integer,
|
|
344
|
+
invalid_context_wire_entries: Array[wire_event],
|
|
345
|
+
tracked_events: Array[TrackedEventEntry],
|
|
346
|
+
taken_at: Time
|
|
347
|
+
) -> instance
|
|
348
|
+
|
|
349
|
+
def empty?: () -> bool
|
|
350
|
+
|
|
351
|
+
def wire_events: () -> Hash[Symbol, untyped]
|
|
352
|
+
|
|
353
|
+
private
|
|
354
|
+
|
|
355
|
+
def wire_counts_of_what_was_dropped: () -> Hash[Symbol, Integer]
|
|
356
|
+
|
|
357
|
+
def aggregated_evaluations: () -> Array[wire_event]
|
|
358
|
+
|
|
359
|
+
def counts_by_wire_event: () -> Hash[wire_event, Integer]
|
|
360
|
+
end
|
|
361
|
+
|
|
362
|
+
class CollectedTelemetry
|
|
363
|
+
SHARE_OF_THE_EVENT_QUEUE_FOR_EVALUATIONS: Float
|
|
364
|
+
SHARE_OF_THE_EVENT_QUEUE_FOR_CAPTURED_CONTEXTS: Float
|
|
365
|
+
REPORTER_OF_WHAT_THE_PARENT_PROCESS_COLLECTED_BY_WHAT_FORKED: Hash[Symbol, Symbol]
|
|
366
|
+
|
|
367
|
+
@evaluations_limit: Integer
|
|
368
|
+
@captured_contexts_limit: Integer
|
|
369
|
+
@invalid_context_submissions: InvalidContextSubmissions
|
|
370
|
+
@tracked_event_queue: TrackedEventQueue
|
|
371
|
+
@collecting_process_id: Integer
|
|
372
|
+
@evaluations: Array[ReportedEvaluation]
|
|
373
|
+
@evaluations_collected_since: Time?
|
|
374
|
+
@evaluations_dropped: Integer
|
|
375
|
+
@captured_contexts: Hash[[String, String], ReportedContext]
|
|
376
|
+
@captured_contexts_dropped: Integer
|
|
377
|
+
|
|
378
|
+
def initialize: (Integer event_queue_limit) -> void
|
|
379
|
+
|
|
380
|
+
def add_evaluation: (Client::EvaluatedRead evaluated_read) -> void
|
|
381
|
+
|
|
382
|
+
def add_tracked_event: (tracked_event_admission admission) -> Array[String]
|
|
383
|
+
|
|
384
|
+
def count_invalid_context: (String kind_sample) -> invalid_context_recording
|
|
385
|
+
|
|
386
|
+
def choose_the_reporter_of_what_the_parent_process_collected: (Symbol forked_through) -> void
|
|
387
|
+
|
|
388
|
+
def taken_for_a_report: () -> TelemetryReport
|
|
389
|
+
|
|
390
|
+
def discard_the_queued_events: () -> void
|
|
391
|
+
|
|
392
|
+
private
|
|
393
|
+
|
|
394
|
+
def leave_to_the_parent_process_what_it_collected: () -> void
|
|
395
|
+
|
|
396
|
+
def capture: (ReportedContext reported_context) -> void
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
class ReportTiming < Data
|
|
400
|
+
attr_reader seconds_before_the_first_report: seconds
|
|
401
|
+
attr_reader seconds_between_reports: seconds
|
|
402
|
+
attr_reader seconds_a_report_may_take: seconds
|
|
403
|
+
|
|
404
|
+
def self.new: (
|
|
405
|
+
seconds_before_the_first_report: seconds,
|
|
406
|
+
seconds_between_reports: seconds,
|
|
407
|
+
seconds_a_report_may_take: seconds
|
|
408
|
+
) -> instance
|
|
409
|
+
|
|
410
|
+
def self.of_a_client_reporting_every: (seconds seconds_between_reports) -> ReportTiming
|
|
411
|
+
end
|
|
412
|
+
|
|
413
|
+
class ReportAnswer < Data
|
|
414
|
+
ACCEPTED_STATUSES: Range[Integer]
|
|
415
|
+
REPORT_TOO_LARGE_STATUS: Integer
|
|
416
|
+
TOO_MANY_REQUESTS_STATUS: Integer
|
|
417
|
+
STATUSES_THAT_END_TELEMETRY: Array[Integer]
|
|
418
|
+
|
|
419
|
+
attr_reader kind: report_answer_kind
|
|
420
|
+
attr_reader status: Integer?
|
|
421
|
+
attr_reader detail: String?
|
|
422
|
+
|
|
423
|
+
def self.new: (kind: report_answer_kind, status: Integer?, detail: String?) -> instance
|
|
424
|
+
|
|
425
|
+
def self.with_status: (Integer status) -> ReportAnswer
|
|
426
|
+
|
|
427
|
+
def self.unanswered: (String detail) -> ReportAnswer
|
|
428
|
+
end
|
|
429
|
+
|
|
430
|
+
class TelemetryEndpoint
|
|
431
|
+
@telemetry_uri: URI::Generic
|
|
432
|
+
@server_sdk_key: String
|
|
433
|
+
@sdk_identity: Identity::SdkIdentity
|
|
434
|
+
@meta_context: Hash[Symbol, String]
|
|
435
|
+
@seconds_a_report_may_take: seconds
|
|
436
|
+
|
|
437
|
+
def initialize: (
|
|
438
|
+
url: String,
|
|
439
|
+
server_sdk_key: String,
|
|
440
|
+
metadata: Metadata,
|
|
441
|
+
sdk_identity: Identity::SdkIdentity,
|
|
442
|
+
seconds_a_report_may_take: seconds
|
|
443
|
+
) -> void
|
|
444
|
+
|
|
445
|
+
def answer_to: (TelemetryReport report) -> ReportAnswer
|
|
446
|
+
|
|
447
|
+
private
|
|
448
|
+
|
|
449
|
+
def answer_before: (Connection::RequestDeadline deadline, Net::HTTP::Post json_post) -> ReportAnswer
|
|
450
|
+
|
|
451
|
+
def json_post_of: (TelemetryReport report) -> Net::HTTP::Post
|
|
452
|
+
|
|
453
|
+
def response_to: (Net::HTTP::Post json_post, Connection::RequestDeadline deadline) -> Net::HTTPResponse
|
|
454
|
+
end
|
|
455
|
+
|
|
456
|
+
class EventReporter
|
|
457
|
+
WHAT_FOLLOWS_BY_ANSWER_KIND: Hash[Symbol, Symbol]
|
|
458
|
+
LOG_BY_ANSWER_KIND: Hash[Symbol, ^(Logging::ClientLog log, ReportAnswer answer) -> void]
|
|
459
|
+
|
|
460
|
+
@endpoint: TelemetryEndpoint
|
|
461
|
+
@log: Logging::ClientLog
|
|
462
|
+
|
|
463
|
+
def initialize: (TelemetryEndpoint endpoint, _Logger & Object logger) -> void
|
|
464
|
+
|
|
465
|
+
def what_follows_delivering: (TelemetryReport report) -> Symbol
|
|
466
|
+
end
|
|
467
|
+
|
|
468
|
+
class ReportSchedule
|
|
469
|
+
@timing: ReportTiming
|
|
470
|
+
@lock: Thread::Mutex
|
|
471
|
+
@no_longer_waiting_for_the_next_report: Thread::ConditionVariable
|
|
472
|
+
@stopped: bool
|
|
473
|
+
@thread: Thread?
|
|
474
|
+
|
|
475
|
+
def initialize: (ReportTiming timing) -> void
|
|
476
|
+
|
|
477
|
+
def start: () { () -> void } -> void
|
|
478
|
+
|
|
479
|
+
def stop: () -> void
|
|
480
|
+
|
|
481
|
+
def wait_for_a_report_being_sent: () -> void
|
|
482
|
+
|
|
483
|
+
private
|
|
484
|
+
|
|
485
|
+
def send_a_report_on_every_interval: (^() -> void send_a_report) -> void
|
|
486
|
+
|
|
487
|
+
def stopped_within?: (seconds seconds) -> bool
|
|
488
|
+
end
|
|
489
|
+
|
|
490
|
+
class DiscardedTelemetry
|
|
491
|
+
include _ClientTelemetry
|
|
492
|
+
|
|
493
|
+
def self.for_a_client_with: (**untyped) -> DiscardedTelemetry
|
|
494
|
+
end
|
|
495
|
+
|
|
496
|
+
class TestClientTelemetry < DiscardedTelemetry
|
|
497
|
+
attr_reader tracked_events: Array[Testing::TrackedEvent]
|
|
498
|
+
|
|
499
|
+
def initialize: () -> void
|
|
500
|
+
|
|
501
|
+
private
|
|
502
|
+
|
|
503
|
+
def tracked_event_recorded_from: (AdmittedTrackedEvent admission) -> Testing::TrackedEvent
|
|
504
|
+
end
|
|
505
|
+
|
|
506
|
+
class ReportedTelemetry
|
|
507
|
+
include _ClientTelemetry
|
|
508
|
+
|
|
509
|
+
COLLECTS_BY_REPORTING: Hash[Symbol, bool]
|
|
510
|
+
|
|
511
|
+
@reporter: EventReporter
|
|
512
|
+
@collected_telemetry: CollectedTelemetry
|
|
513
|
+
@schedule: ReportSchedule
|
|
514
|
+
@log: Logging::ClientLog
|
|
515
|
+
@lock: Thread::Mutex
|
|
516
|
+
@reporting: Symbol
|
|
517
|
+
|
|
518
|
+
def self.for_a_client_with: (
|
|
519
|
+
server_sdk_key: String,
|
|
520
|
+
metadata: Metadata,
|
|
521
|
+
connection_options: ConnectionOptions,
|
|
522
|
+
telemetry_options: TelemetryOptions,
|
|
523
|
+
sdk_identity: Identity::SdkIdentity,
|
|
524
|
+
logger: _Logger & Object
|
|
525
|
+
) -> ReportedTelemetry
|
|
526
|
+
|
|
527
|
+
def self.reporting_to: (
|
|
528
|
+
url: String,
|
|
529
|
+
server_sdk_key: String,
|
|
530
|
+
metadata: Metadata,
|
|
531
|
+
sdk_identity: Identity::SdkIdentity,
|
|
532
|
+
event_queue_limit: Integer,
|
|
533
|
+
timing: ReportTiming,
|
|
534
|
+
logger: _Logger & Object
|
|
535
|
+
) -> ReportedTelemetry
|
|
536
|
+
|
|
537
|
+
def initialize: (
|
|
538
|
+
reporter: EventReporter,
|
|
539
|
+
collected_telemetry: CollectedTelemetry,
|
|
540
|
+
schedule: ReportSchedule,
|
|
541
|
+
logger: _Logger & Object
|
|
542
|
+
) -> void
|
|
543
|
+
|
|
544
|
+
private
|
|
545
|
+
|
|
546
|
+
def start_the_schedule_when_reporting_on_it: () -> void
|
|
547
|
+
|
|
548
|
+
def report_what_was_collected: () -> void
|
|
549
|
+
|
|
550
|
+
def send_to_the_endpoint: (TelemetryReport report) -> void
|
|
551
|
+
|
|
552
|
+
def stop_collecting: () -> void
|
|
553
|
+
end
|
|
554
|
+
end
|
|
555
|
+
end
|
|
556
|
+
end
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
module ConfigDirector
|
|
2
|
+
module Internal
|
|
3
|
+
module Value
|
|
4
|
+
type in_code_default_value_kind = :boolean | :string | :integer | :float | :json_object | :json_array
|
|
5
|
+
|
|
6
|
+
class InCodeDefaultValue < Data
|
|
7
|
+
attr_reader value: config_value
|
|
8
|
+
attr_reader kind: in_code_default_value_kind
|
|
9
|
+
|
|
10
|
+
def self.new: (value: config_value, kind: in_code_default_value_kind) -> instance
|
|
11
|
+
|
|
12
|
+
def self.from: (untyped default_value) -> InCodeDefaultValue
|
|
13
|
+
|
|
14
|
+
private def self.kind_of: (untyped default_value) -> in_code_default_value_kind?
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
class UnservableValue < ConfigDirectorError
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
class EncodedNativeValue < Data
|
|
21
|
+
attr_reader config_type: String
|
|
22
|
+
attr_reader served_text: String
|
|
23
|
+
|
|
24
|
+
def self.new: (config_type: String, served_text: String) -> instance
|
|
25
|
+
|
|
26
|
+
def self.of: (untyped value, String config_key) -> EncodedNativeValue
|
|
27
|
+
|
|
28
|
+
private def self.encoded_float: (Float value, String config_key) -> EncodedNativeValue
|
|
29
|
+
|
|
30
|
+
private def self.utf8_text_of: (String value, String config_key) -> String
|
|
31
|
+
|
|
32
|
+
private def self.unservable_because_of_the_class_of: (untyped value, String config_key) -> UnservableValue
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
module PlainDecimalText
|
|
36
|
+
DIGITS_UP_TO_THE_LAST_NONZERO_ONE: Regexp
|
|
37
|
+
|
|
38
|
+
def self.of: (Float finite_float) -> String
|
|
39
|
+
|
|
40
|
+
private def self.parts_around_the_point: (String digits, Integer digits_before_the_point) -> [String, String]
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
module Utf8Text
|
|
44
|
+
def self.of: (String text) -> String?
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
module HashKeys
|
|
48
|
+
def self.name_of: (untyped given_key) -> String?
|
|
49
|
+
|
|
50
|
+
def self.description_of_a_key_given_twice_in: (Array[untyped] given_keys, Array[String] key_texts) -> String?
|
|
51
|
+
|
|
52
|
+
private def self.how_the_two_keys_differ: (untyped first_given, untyped second_given) -> String
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
module NativeValues
|
|
56
|
+
def self.reject_values_of_another_class: (untyped values) -> void
|
|
57
|
+
|
|
58
|
+
def self.config_keys_of: (Hash[untyped, untyped] values) -> Array[String]
|
|
59
|
+
|
|
60
|
+
def self.name_of_a_config_key: (untyped given_key) -> String
|
|
61
|
+
|
|
62
|
+
private def self.config_key_named_by: (untyped given_key) -> String
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
class JsonPosition < Data
|
|
66
|
+
attr_reader config_key: String
|
|
67
|
+
attr_reader path: String
|
|
68
|
+
attr_reader nesting: Integer
|
|
69
|
+
|
|
70
|
+
def self.new: (config_key: String, path: String, nesting: Integer) -> instance
|
|
71
|
+
|
|
72
|
+
def self.at_the_top_of: (String config_key) -> JsonPosition
|
|
73
|
+
|
|
74
|
+
def of_member: (String key_text) -> JsonPosition
|
|
75
|
+
|
|
76
|
+
def of_element: (Integer index) -> JsonPosition
|
|
77
|
+
|
|
78
|
+
def unservable_because: (String problem) -> UnservableValue
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
module JsonContents
|
|
82
|
+
MAXIMUM_NESTING: Integer
|
|
83
|
+
WHAT_JSON_CONTENTS_CAN_HOLD: String
|
|
84
|
+
|
|
85
|
+
def self.json_text_of: (Hash[untyped, untyped] | Array[untyped] json_value, String config_key) -> String
|
|
86
|
+
|
|
87
|
+
private def self.contents_at: (JsonPosition position, untyped contents) -> untyped
|
|
88
|
+
|
|
89
|
+
private def self.utf8_text_at: (JsonPosition position, String text) -> String
|
|
90
|
+
|
|
91
|
+
private def self.finite_float_at: (JsonPosition position, Float float) -> Float
|
|
92
|
+
|
|
93
|
+
private def self.container_contents_at: (
|
|
94
|
+
JsonPosition position,
|
|
95
|
+
Hash[untyped, untyped] | Array[untyped] container
|
|
96
|
+
) -> (Hash[String, untyped] | Array[untyped])
|
|
97
|
+
|
|
98
|
+
private def self.members_at: (JsonPosition position, Hash[untyped, untyped] json_object) -> Hash[String, untyped]
|
|
99
|
+
|
|
100
|
+
private def self.key_text_at: (JsonPosition position, untyped given_key) -> String
|
|
101
|
+
|
|
102
|
+
private def self.unservable_contents_at: (JsonPosition position, String problem) -> UnservableValue
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
class TypedValue < Data
|
|
106
|
+
attr_reader value: config_value
|
|
107
|
+
|
|
108
|
+
def self.new: (value: config_value) -> instance
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
module ParsedJson
|
|
112
|
+
MOST_DIGITS_OF_A_NUMBER: Integer
|
|
113
|
+
MORE_DIGITS_THAN_A_NUMBER_HAS: String
|
|
114
|
+
QUOTE: String
|
|
115
|
+
QUOTE_OR_SLASH: Regexp
|
|
116
|
+
QUOTE_OR_BACKSLASH: Regexp
|
|
117
|
+
END_OF_A_COMMENT_BY_ITS_START: Hash[String, String]
|
|
118
|
+
|
|
119
|
+
def self.of: (String json_text) -> untyped
|
|
120
|
+
|
|
121
|
+
private def self.parsed_without_repeating_the_text_in_an_error: (String json_text) -> untyped
|
|
122
|
+
|
|
123
|
+
private def self.number_with_too_many_digits_in?: (String json_bytes) -> bool
|
|
124
|
+
|
|
125
|
+
private def self.run_of_too_many_digits_in?: (String bytes) -> bool
|
|
126
|
+
|
|
127
|
+
private def self.bytes_outside_the_strings_and_comments_of: (String json_bytes) -> String
|
|
128
|
+
|
|
129
|
+
private def self.position_after_what_opens_at: (Integer quote_or_slash, String json_bytes) -> Integer
|
|
130
|
+
|
|
131
|
+
private def self.position_after_the_string_opened_at: (Integer opening_quote, String json_bytes) -> Integer
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
module ServedText
|
|
135
|
+
CONFIG_TYPES_NOT_READABLE_AS_A_STRING: Array[String]
|
|
136
|
+
WHOLE_NUMBER_DIGITS: Regexp
|
|
137
|
+
TYPED_BY_IN_CODE_DEFAULT_VALUE_KIND: Hash[Symbol, ^(String served_text, String config_type) -> (TypedValue | String)]
|
|
138
|
+
|
|
139
|
+
def self.typed_as: (
|
|
140
|
+
in_code_default_value_kind in_code_default_value_kind,
|
|
141
|
+
String? served_text,
|
|
142
|
+
String config_type
|
|
143
|
+
) -> (TypedValue | String)
|
|
144
|
+
|
|
145
|
+
private def self.boolean_in: (String served_text) -> (TypedValue | String)
|
|
146
|
+
|
|
147
|
+
private def self.string_of: (String served_text, String config_type) -> (TypedValue | String)
|
|
148
|
+
|
|
149
|
+
private def self.whole_number_in: (String served_text) -> (TypedValue | String)
|
|
150
|
+
|
|
151
|
+
private def self.digits_of_a_whole_number?: (String served_text) -> bool
|
|
152
|
+
|
|
153
|
+
private def self.finite_number_in: (String served_text) -> (TypedValue | String)
|
|
154
|
+
|
|
155
|
+
private def self.json_in: (String served_text, Class json_class) -> (TypedValue | String)
|
|
156
|
+
end
|
|
157
|
+
end
|
|
158
|
+
end
|
|
159
|
+
end
|