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,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ConfigDirector
4
+ module Testing
5
+ TrackedEvent = Data.define(:name, :context, :value, :details)
6
+
7
+ # An event the code under test tracked through the client of a {TestClient}, as {TestClient#tracked_events}
8
+ # holds it. Two events with the same values are equal, so a test can compare the list with the events it expects.
9
+ #
10
+ # @example
11
+ # test_client.client.track("checkout-completed", ConfigDirector::Context.new(id: "user-123"), value: 49.9)
12
+ #
13
+ # expect(test_client.tracked_events).to eq(
14
+ # [
15
+ # ConfigDirector::Testing::TrackedEvent.new(
16
+ # name: "checkout-completed", context: ConfigDirector::Context.new(id: "user-123"), value: 49.9
17
+ # )
18
+ # ]
19
+ # )
20
+ #
21
+ # @!attribute [r] name
22
+ # @return [String] the name the event was tracked with. A Symbol is held as its name.
23
+ # @!attribute [r] context
24
+ # @return [Context, nil] the context the event was tracked for, or +nil+ when there was none or its kind was
25
+ # invalid
26
+ # @!attribute [r] value
27
+ # @return [Integer, Float, nil] the value the event was tracked with, or +nil+ when there was none or it was
28
+ # not a finite number
29
+ # @!attribute [r] details
30
+ # @return [Hash{String => Object}, nil] the details the event was tracked with, as the SDK sends them: keys
31
+ # and Symbols as their names, a Time as its ISO 8601 text in UTC, a Float that is not finite as +nil+, and a
32
+ # whole Float such as +50.0+ as the Integer +50+. +nil+ when there were none or the SDK leaves them out.
33
+ class TrackedEvent
34
+ # @param name [String] the name the event was tracked with
35
+ # @param context [Context, nil] the context the event was tracked for
36
+ # @param value [Integer, Float, nil] the value the event was tracked with
37
+ # @param details [Hash{String => Object}, nil] the details, as the SDK sends them, with String keys
38
+ def initialize(name:, context: nil, value: nil, details: nil)
39
+ super(
40
+ name: Internal::UnchangeableCopy.of(name), context: context, value: value,
41
+ details: Internal::UnchangeableCopy.of(details)
42
+ )
43
+ end
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../configdirector"
4
+ require_relative "internal/connection/test_client_values"
5
+ require_relative "internal/connection/test_client_initializations"
6
+ require_relative "internal/connection/payloads_delivered_in_turn"
7
+ require_relative "internal/connection/in_memory_connection"
8
+ require_relative "internal/telemetry/test_client_telemetry"
9
+ require_relative "testing/tracked_event"
10
+ require_relative "testing/test_client"
11
+
12
+ module ConfigDirector
13
+ # The testing tools of the ConfigDirector server SDK, loaded with <tt>require "configdirector/testing"</tt>.
14
+ module Testing
15
+ # Creates a {TestClient}: the SDK's real client over an in-memory connection that the test controls. It needs
16
+ # no server SDK key, never connects to ConfigDirector, starts no thread and sends nothing.
17
+ #
18
+ # @example
19
+ # require "configdirector/testing"
20
+ #
21
+ # test_client = ConfigDirector::Testing.create_test_client({ "new-checkout" => true })
22
+ # service = CheckoutService.new(test_client.client)
23
+ # test_client.client.init
24
+ #
25
+ # expect(service.new_checkout_enabled?("user-123")).to be(true)
26
+ #
27
+ # test_client.set_value("new-checkout", false)
28
+ # expect(service.new_checkout_enabled?("user-123")).to be(false)
29
+ #
30
+ # @param values [Hash{String, Symbol => Boolean, Integer, Float, String, Hash, Array}, nil] the values to
31
+ # serve, keyed by config key, as {TestClient#set_value} takes them. Defaults to none.
32
+ # @param timeout [Integer, Float, nil] how long an +init+ that {TestClient#hold_initialization} held waits, in
33
+ # seconds. Defaults to 3 seconds, the timeout of a production client.
34
+ # @param logger [#debug, #info, #warn, #error, nil] a logger with the methods of Ruby's +Logger+, as
35
+ # {ConfigDirector.create_client} takes it. Without one the SDK writes warnings and errors to standard error.
36
+ # @return [TestClient] a test client whose client is not initialized yet
37
+ # @raise [ConfigDirectorValidationError] when +values+ is not a Hash or holds a key or a value the SDK cannot
38
+ # serve, as {TestClient#set_value} describes; when +timeout+ is not a positive number; or when the +logger+
39
+ # lacks one of the four methods
40
+ def self.create_test_client(values = nil, timeout: nil, logger: nil)
41
+ Internal::Client::ClientFactory.test_client_serving(values, timeout: timeout, logger: logger)
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ConfigDirector
4
+ Variation = Data.define(:id, :name)
5
+
6
+ # One of the values a config can serve, such as the control or a treatment of an experiment. Two variations
7
+ # with the same values are equal.
8
+ #
9
+ # @!attribute [r] id
10
+ # @return [String] the ID ConfigDirector assigned to the variation, which stays the same when the
11
+ # variation is renamed
12
+ # @!attribute [r] name
13
+ # @return [String, nil] the variation's name, when it has one
14
+ class Variation
15
+ # @param id [String] the ID ConfigDirector assigned to the variation
16
+ # @param name [String, nil] the variation's name
17
+ def initialize(id:, name: nil)
18
+ super
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ # The ConfigDirector server SDK.
4
+ module ConfigDirector
5
+ # The version of this gem.
6
+ VERSION = "0.1.0"
7
+ end
@@ -0,0 +1,3 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "configdirector"
@@ -0,0 +1,164 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "configdirector/version"
4
+ require_relative "configdirector/errors"
5
+ require_relative "configdirector/internal"
6
+ require_relative "configdirector/internal/unchangeable_copy"
7
+ require_relative "configdirector/metadata"
8
+ require_relative "configdirector/connection_options"
9
+ require_relative "configdirector/telemetry_options"
10
+ require_relative "configdirector/client_hooks"
11
+ require_relative "configdirector/internal/client/context_attributes"
12
+ require_relative "configdirector/context"
13
+ require_relative "configdirector/variation"
14
+ require_relative "configdirector/config_state"
15
+ require_relative "configdirector/config_evaluation"
16
+ require_relative "configdirector/configs_updated_event"
17
+ require_relative "configdirector/config_evaluated_event"
18
+ require_relative "configdirector/connection_error_event"
19
+ require_relative "configdirector/subscription"
20
+ require_relative "configdirector/internal/evaluation"
21
+ require_relative "configdirector/internal/value/typed_value"
22
+ require_relative "configdirector/internal/value/in_code_default_value"
23
+ require_relative "configdirector/internal/value/parsed_json"
24
+ require_relative "configdirector/internal/value/served_text"
25
+ require_relative "configdirector/internal/value/unservable_value"
26
+ require_relative "configdirector/internal/value/plain_decimal_text"
27
+ require_relative "configdirector/internal/value/utf8_text"
28
+ require_relative "configdirector/internal/value/hash_keys"
29
+ require_relative "configdirector/internal/value/native_values"
30
+ require_relative "configdirector/internal/value/json_position"
31
+ require_relative "configdirector/internal/value/json_contents"
32
+ require_relative "configdirector/internal/value/encoded_native_value"
33
+ require_relative "configdirector/internal/server_sent_events/server_sent_event"
34
+ require_relative "configdirector/internal/server_sent_events/event_stream_limit_exceeded"
35
+ require_relative "configdirector/internal/server_sent_events/event_stream_parser"
36
+ require_relative "configdirector/internal/identity/sdk_identity"
37
+ require_relative "configdirector/internal/identity/wrapper"
38
+ require_relative "configdirector/internal/connection/not_a_server_sdk_payload"
39
+ require_relative "configdirector/internal/connection/unreadable_definition"
40
+ require_relative "configdirector/internal/connection/server_sdk_payload"
41
+ require_relative "configdirector/internal/connection/config_definition"
42
+ require_relative "configdirector/internal/connection/wire_fields"
43
+ require_relative "configdirector/internal/connection/condition_parser"
44
+ require_relative "configdirector/internal/connection/targeting_rules_parser"
45
+ require_relative "configdirector/internal/connection/server_sdk_payload_parser"
46
+ require_relative "configdirector/internal/connection/offline_values_file"
47
+ require_relative "configdirector/internal/connection/offline_mode_connection"
48
+ require_relative "configdirector/internal/connection/polling_interval"
49
+ require_relative "configdirector/internal/connection/json_post_request"
50
+ require_relative "configdirector/internal/connection/request_deadline"
51
+ require_relative "configdirector/internal/connection/http_session"
52
+ require_relative "configdirector/internal/connection/retry_after_header"
53
+ require_relative "configdirector/internal/logging/default_logger"
54
+ require_relative "configdirector/internal/logging/client_log"
55
+ require_relative "configdirector/internal/stoppable_thread"
56
+ require_relative "configdirector/internal/streaming/stream_timing"
57
+ require_relative "configdirector/internal/streaming/stream_endpoint"
58
+ require_relative "configdirector/internal/streaming/reconnection_delay"
59
+ require_relative "configdirector/internal/streaming/stream_end"
60
+ require_relative "configdirector/internal/streaming/stream_connection"
61
+ require_relative "configdirector/internal/streaming/heartbeats"
62
+ require_relative "configdirector/internal/streaming/reconnecting_stream"
63
+ require_relative "configdirector/internal/streaming/streaming_transport"
64
+ require_relative "configdirector/internal/streaming/streaming_mode_connection"
65
+ require_relative "configdirector/internal/polling/poll_timing"
66
+ require_relative "configdirector/internal/polling/refusal_detail"
67
+ require_relative "configdirector/internal/polling/poll_answer"
68
+ require_relative "configdirector/internal/polling/polling_endpoint"
69
+ require_relative "configdirector/internal/polling/poll_request"
70
+ require_relative "configdirector/internal/polling/polling_session"
71
+ require_relative "configdirector/internal/polling/polling_transport"
72
+ require_relative "configdirector/internal/polling/polling_mode_connection"
73
+ require_relative "configdirector/internal/telemetry/value_id"
74
+ require_relative "configdirector/internal/telemetry/reported_text"
75
+ require_relative "configdirector/internal/telemetry/written_json"
76
+ require_relative "configdirector/internal/telemetry/compact_json_text"
77
+ require_relative "configdirector/internal/telemetry/reported_value"
78
+ require_relative "configdirector/internal/telemetry/reported_time"
79
+ require_relative "configdirector/internal/telemetry/aggregated_wire_entries"
80
+ require_relative "configdirector/internal/telemetry/reported_context"
81
+ require_relative "configdirector/internal/telemetry/reported_evaluation"
82
+ require_relative "configdirector/internal/telemetry/invalid_context_submissions"
83
+ require_relative "configdirector/internal/telemetry/reported_details"
84
+ require_relative "configdirector/internal/telemetry/tracked_event_entry"
85
+ require_relative "configdirector/internal/telemetry/tracked_event_queue"
86
+ require_relative "configdirector/internal/telemetry/tracked_event_admission"
87
+ require_relative "configdirector/internal/telemetry/tracked_event_warning"
88
+ require_relative "configdirector/internal/telemetry/telemetry_report"
89
+ require_relative "configdirector/internal/telemetry/collected_telemetry"
90
+ require_relative "configdirector/internal/telemetry/report_timing"
91
+ require_relative "configdirector/internal/telemetry/report_answer"
92
+ require_relative "configdirector/internal/telemetry/telemetry_endpoint"
93
+ require_relative "configdirector/internal/telemetry/event_reporter"
94
+ require_relative "configdirector/internal/telemetry/report_schedule"
95
+ require_relative "configdirector/internal/telemetry/discarded_telemetry"
96
+ require_relative "configdirector/internal/telemetry/reported_telemetry"
97
+ require_relative "configdirector/internal/client/number_of_seconds"
98
+ require_relative "configdirector/internal/client/connection_options_validation"
99
+ require_relative "configdirector/internal/client/client_options_validation"
100
+ require_relative "configdirector/internal/client/context_kind"
101
+ require_relative "configdirector/internal/client/context_admission"
102
+ require_relative "configdirector/internal/client/evaluated_read"
103
+ require_relative "configdirector/internal/client/config_read"
104
+ require_relative "configdirector/internal/client/served_configs"
105
+ require_relative "configdirector/internal/client/serving_state"
106
+ require_relative "configdirector/internal/client/registrations"
107
+ require_relative "configdirector/internal/client/event_handlers"
108
+ require_relative "configdirector/internal/client/watches"
109
+ require_relative "configdirector/internal/client/config_reader"
110
+ require_relative "configdirector/internal/client/event_tracking"
111
+ require_relative "configdirector/internal/client/connection_intake"
112
+ require_relative "configdirector/internal/client/what_follows_a_fork"
113
+ require_relative "configdirector/internal/client/restart_in_forked_processes"
114
+ require_relative "configdirector/internal/client/live_client_connections"
115
+ require_relative "configdirector/internal/client/client_connection"
116
+ require_relative "configdirector/internal/client/client_factory"
117
+ require_relative "configdirector/config_director_client"
118
+
119
+ # The ConfigDirector server SDK.
120
+ module ConfigDirector
121
+ # Creates a ConfigDirector client. It returns a client that is not initialized and makes no network call:
122
+ # call {ConfigDirectorClient#init} before the first read.
123
+ #
124
+ # @example
125
+ # client = ConfigDirector.create_client(
126
+ # ENV.fetch("CONFIGDIRECTOR_SERVER_KEY"),
127
+ # metadata: ConfigDirector::Metadata.new(app_name: "my-awesome-app", app_version: "1.0.0")
128
+ # )
129
+ # client.init
130
+ #
131
+ # @param server_sdk_key [String, nil] the ConfigDirector server SDK key. This is a secret value, do not
132
+ # commit it in your source code. It can be left out in offline mode only.
133
+ # @param metadata [Metadata, nil] metadata about your application. Including +app_name+ and +app_version+
134
+ # is recommended, so that you can use them in targeting rules.
135
+ # @param connection [ConnectionOptions, nil] how the client connects to ConfigDirector
136
+ # @param logger [#debug, #info, #warn, #error, nil] a logger with the methods of Ruby's +Logger+, such as
137
+ # +Rails.logger+. The SDK calls each method with one String. Without a logger the SDK writes warnings
138
+ # and errors to standard error.
139
+ # @param log_level [Integer, Symbol, String, nil] the lowest level the SDK writes when no +logger+ is
140
+ # given, as Ruby's +Logger+ takes it, such as +:debug+ or +Logger::INFO+. Defaults to +:warn+. It has no
141
+ # effect when a +logger+ is given.
142
+ # @param telemetry [TelemetryOptions, nil] telemetry tuning
143
+ # @param hooks [ClientHooks, nil] handlers for the events the client emits
144
+ # @return [ConfigDirectorClient] a client that is not initialized
145
+ # @raise [ConfigDirectorValidationError] when the server SDK key is missing or blank, +connection.url+
146
+ # is not an http or https URL, +connection.timeout+ is not a positive number, or +connection.file+ or
147
+ # +connection.values+ is given, all outside offline mode only; when +connection.mode+ is not a connection
148
+ # mode; in offline mode, when +connection.timeout+ is not a number, when both +connection.file+ and
149
+ # +connection.values+ are given, when +connection.values+ is not a Hash or +connection.file+ is neither
150
+ # a String nor a Pathname, or when +connection.values+ holds a key that is blank, of another class, not
151
+ # UTF-8 text or given twice, or a value the SDK cannot serve; when +telemetry.flush_interval+ is not a
152
+ # positive number; when +connection.polling_interval+ is not a number; when +telemetry.event_queue_limit+
153
+ # is not a whole number from 100 to 100,000; when an option is not an object of its option class; when
154
+ # the +logger+ lacks one of the four methods; or when +log_level+ is not a level and no +logger+ is given
155
+ def self.create_client(
156
+ server_sdk_key = nil, metadata: nil, connection: nil, logger: nil, log_level: nil, telemetry: nil, hooks: nil
157
+ )
158
+ Internal::Client::ClientFactory.client_identified_as(
159
+ Internal::Identity::SdkIdentity.of_the_server_sdk, server_sdk_key,
160
+ metadata: metadata, connection: connection, logger: logger, log_level: log_level, telemetry: telemetry,
161
+ hooks: hooks
162
+ )
163
+ end
164
+ end