quonfig-openfeature 2.0.0 → 2.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 20da9ec1d24f20fa576a6430d8cd765b6d821a2cc052e0bfb8f59a5511b8447a
4
- data.tar.gz: 333ea7e9395c479af7e7768bdb256c79860e7c495e009e9c51e8d14af51807e4
3
+ metadata.gz: cd942b88517b56c8ff6d676684e0f1c27fbd5fd62c96c15964af1239d0ac2fe6
4
+ data.tar.gz: bff802046f4d1ec5c0422e93f7c13a28edeb98178f2703354511976dc4c3384e
5
5
  SHA512:
6
- metadata.gz: b3319e1dbd57f6bcfa125befb424e8c2f811dc3c01f921b94c3426a0e62eed5f3ab100a49c372236e68adaa1fde3ca5d259d55af09800c40e0a4043393915c2d
7
- data.tar.gz: 5cc0aecc4fcd057d426ae31381572bb27e97160dea9e154cc84e85bf668849618d5a2def62c950f3713353aef3c6f1d0c8e386055bcc35cd58b0affd1e3e0321
6
+ metadata.gz: 57db850f4f8384be2cc8b47e690ff363876d9ab51a5c7e80468880b3cf9b4607b7263f9081b965feef1dc6cc3e3c0594180153cb67cf9a5317fb7025562e70a9
7
+ data.tar.gz: 56bb8b4420465725dd15303de581c254abae3d5f27a98205463dbed394f9cc9848ae47c61d97f7ac89962d707fa35ae8ed6d8c05fb66c2f9e0a50050c434123f
data/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # Changelog
2
2
 
3
+ ## 2.1.0 - 2026-10-28
4
+
5
+ A malformed value now resolves with error code `PARSE_ERROR` instead of `TYPE_MISMATCH`
6
+ (qfg-9xsl, mirrors integration-test-data `tests/openfeature/openfeature.yaml` Case 6). You still
7
+ get your default with reason `ERROR`. This covers a value of a type the `fetch_*` method reads that
8
+ does not parse:
9
+
10
+ - a stored int `"twelve"` or double `"abc"`;
11
+ - an int or double provided by an ENV_VAR set to an unparseable string, such as `"twelve"`;
12
+ - a malformed stored duration such as `"30s"`, read with `fetch_string_value`.
13
+
14
+ A read with the method for another type (an int config read with `fetch_boolean_value`) stays
15
+ `TYPE_MISMATCH`, as does a number that parses but does not convert exactly (`fetch_integer_value`
16
+ on `3.9`). sdk-ruby's `*_details` report both cases as `TYPE_MISMATCH`, so the provider tells them
17
+ apart: on a `TYPE_MISMATCH` it checks the config's stored `valueType` and, if the method can read
18
+ that type, reads it with the native getter for that type. If that read fails too, the value is
19
+ malformed. This extra read happens only on the error path.
20
+
21
+ If you alert or branch on `TYPE_MISMATCH` for bad config data, match `PARSE_ERROR` as well.
22
+
3
23
  ## 2.0.0 - 2026-10-27
4
24
 
5
25
  **BREAKING / UPGRADE (major, qfg-zvyy.6).** This release tracks sdk-ruby 2.0.0, the cross-SDK
data/README.md CHANGED
@@ -153,8 +153,10 @@ code `TYPE_MISMATCH`:
153
153
  - Numbers convert only when exact: `fetch_float_value` on an int config returns `30.0`, and
154
154
  `fetch_integer_value` on a double config returns the value only when it is whole and within
155
155
  +/-(2^53-1) (`3.0` -> `3`; `3.9` is a mismatch, never truncated).
156
- - A malformed stored or ENV_VAR value (an int `"twelve"`) also returns your default with
157
- `TYPE_MISMATCH`. An unset ENV_VAR returns your default with `GENERAL`.
156
+ - A malformed value of a type the method reads returns your default with `PARSE_ERROR`: a stored
157
+ int `"twelve"`, an int or double ENV_VAR set to `"twelve"`, or a stored duration `"30s"` read
158
+ with `fetch_string_value`. A read with the method for another type stays `TYPE_MISMATCH`. An
159
+ unset ENV_VAR returns your default with `GENERAL`.
158
160
 
159
161
  sdk-ruby logs one WARN per key when a read returns your default for one of these reasons.
160
162
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 2.0.0
1
+ 2.1.0
@@ -56,6 +56,32 @@ module Quonfig
56
56
  ErrorCode = ::OpenFeature::SDK::Provider::ErrorCode
57
57
  ProviderMetadata = ::OpenFeature::SDK::Provider::ProviderMetadata
58
58
 
59
+ # The stored +valueType+s each fetch method can read: its own type plus
60
+ # the ones it converts exactly (int <-> double, duration -> ISO string).
61
+ # A TYPE_MISMATCH on a config of one of these types means the value
62
+ # did not parse, so it is reported as PARSE_ERROR (qfg-9xsl).
63
+ READABLE_VALUE_TYPES = {
64
+ boolean: %w[bool],
65
+ string: %w[string log_level duration],
66
+ integer: %w[int double],
67
+ float: %w[double int],
68
+ number: %w[int double],
69
+ object: %w[string_list json]
70
+ }.freeze
71
+
72
+ # The native details getter that reads each stored +valueType+ as itself.
73
+ NATIVE_DETAILS_GETTER = {
74
+ 'bool' => :get_bool_details,
75
+ 'string' => :get_string_details,
76
+ 'log_level' => :get_string_details,
77
+ 'duration' => :get_duration_details,
78
+ 'int' => :get_int_details,
79
+ 'double' => :get_float_details,
80
+ 'string_list' => :get_string_list_details,
81
+ 'json' => :get_json_details
82
+ }.freeze
83
+ private_constant :READABLE_VALUE_TYPES, :NATIVE_DETAILS_GETTER
84
+
59
85
  attr_reader :metadata, :targeting_key_mapping
60
86
 
61
87
  # @param sdk_key [String, nil] SDK key for the live delivery service.
@@ -117,13 +143,15 @@ module Quonfig
117
143
 
118
144
  def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)
119
145
  evaluate(flag_key, default_value, evaluation_context) do |client, mapped_ctx|
120
- to_resolution(client.get_bool_details(flag_key, context: mapped_ctx), default_value)
146
+ details = client.get_bool_details(flag_key, context: mapped_ctx)
147
+ to_resolution(details, default_value, parse_error: malformed?(client, flag_key, mapped_ctx, :boolean, details))
121
148
  end
122
149
  end
123
150
 
124
151
  def fetch_string_value(flag_key:, default_value:, evaluation_context: nil)
125
152
  evaluate(flag_key, default_value, evaluation_context) do |client, mapped_ctx|
126
- to_resolution(client.get_string_details(flag_key, context: mapped_ctx), default_value)
153
+ details = client.get_string_details(flag_key, context: mapped_ctx)
154
+ to_resolution(details, default_value, parse_error: malformed?(client, flag_key, mapped_ctx, :string, details))
127
155
  end
128
156
  end
129
157
 
@@ -134,19 +162,21 @@ module Quonfig
134
162
  evaluate(flag_key, default_value, evaluation_context) do |client, mapped_ctx|
135
163
  details = client.get_int_details(flag_key, context: mapped_ctx)
136
164
  details = client.get_float_details(flag_key, context: mapped_ctx) if details.error_code == ::Quonfig::EvaluationDetails::ERROR_TYPE_MISMATCH
137
- to_resolution(details, default_value)
165
+ to_resolution(details, default_value, parse_error: malformed?(client, flag_key, mapped_ctx, :number, details))
138
166
  end
139
167
  end
140
168
 
141
169
  def fetch_integer_value(flag_key:, default_value:, evaluation_context: nil)
142
170
  evaluate(flag_key, default_value, evaluation_context) do |client, mapped_ctx|
143
- to_resolution(client.get_int_details(flag_key, context: mapped_ctx), default_value)
171
+ details = client.get_int_details(flag_key, context: mapped_ctx)
172
+ to_resolution(details, default_value, parse_error: malformed?(client, flag_key, mapped_ctx, :integer, details))
144
173
  end
145
174
  end
146
175
 
147
176
  def fetch_float_value(flag_key:, default_value:, evaluation_context: nil)
148
177
  evaluate(flag_key, default_value, evaluation_context) do |client, mapped_ctx|
149
- to_resolution(client.get_float_details(flag_key, context: mapped_ctx), default_value)
178
+ details = client.get_float_details(flag_key, context: mapped_ctx)
179
+ to_resolution(details, default_value, parse_error: malformed?(client, flag_key, mapped_ctx, :float, details))
150
180
  end
151
181
  end
152
182
 
@@ -157,7 +187,7 @@ module Quonfig
157
187
  evaluate(flag_key, default_value, evaluation_context) do |client, mapped_ctx|
158
188
  details = client.get_string_list_details(flag_key, context: mapped_ctx)
159
189
  details = client.get_json_details(flag_key, context: mapped_ctx) if details.error_code == ::Quonfig::EvaluationDetails::ERROR_TYPE_MISMATCH
160
- to_resolution(details, default_value)
190
+ to_resolution(details, default_value, parse_error: malformed?(client, flag_key, mapped_ctx, :object, details))
161
191
  end
162
192
  end
163
193
 
@@ -198,10 +228,37 @@ module Quonfig
198
228
  end
199
229
  end
200
230
 
231
+ # True when +details+ is a TYPE_MISMATCH for a config whose value has a
232
+ # type +kind+ can read but did not parse: a stored int "twelve", an int
233
+ # ENV_VAR set to "twelve", a duration "30s" (qfg-9xsl). sdk-ruby's
234
+ # *_details report a malformed value and a wrong-type read alike as
235
+ # TYPE_MISMATCH, so this checks the stored +valueType+ and reads the
236
+ # config with the getter for that type: if that read fails too, the
237
+ # value is malformed. A config of a type +kind+ cannot read stays
238
+ # TYPE_MISMATCH, and so does a value that parsed but does not convert
239
+ # exactly (fetch_integer_value on a 3.9 double).
240
+ def malformed?(client, flag_key, mapped_ctx, kind, details)
241
+ return false unless details.error_code == ::Quonfig::EvaluationDetails::ERROR_TYPE_MISMATCH
242
+
243
+ value_type = stored_value_type(client, flag_key)
244
+ return false unless READABLE_VALUE_TYPES.fetch(kind).include?(value_type)
245
+
246
+ native = client.public_send(NATIVE_DETAILS_GETTER.fetch(value_type), flag_key, context: mapped_ctx)
247
+ native.error_code == ::Quonfig::EvaluationDetails::ERROR_TYPE_MISMATCH
248
+ end
249
+
250
+ def stored_value_type(client, flag_key)
251
+ config = client.store.get(flag_key)
252
+ return nil unless config.is_a?(Hash)
253
+
254
+ (config['valueType'] || config[:valueType] || config['value_type'] || config[:value_type])&.to_s
255
+ end
256
+
201
257
  # Map a Quonfig::EvaluationDetails to the OpenFeature ResolutionDetails
202
258
  # the SDK consumes. The Quonfig SDK's *_details methods don't raise, so
203
- # this is a pure mapping layer.
204
- def to_resolution(details, default_value)
259
+ # this is a pure mapping layer. +parse_error+ reports an ERROR as
260
+ # PARSE_ERROR (see #malformed?).
261
+ def to_resolution(details, default_value, parse_error: false)
205
262
  variant = details.variant
206
263
  flag_metadata = details.flag_metadata || {}
207
264
  case details.reason
@@ -221,7 +278,7 @@ module Quonfig
221
278
  ResolutionDetails.new(
222
279
  value: default_value,
223
280
  reason: Reason::ERROR,
224
- error_code: map_error_code(details.error_code),
281
+ error_code: parse_error ? ErrorCode::PARSE_ERROR : map_error_code(details.error_code),
225
282
  error_message: details.error_message,
226
283
  variant: variant,
227
284
  flag_metadata: flag_metadata
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: quonfig-openfeature
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.0
4
+ version: 2.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jeff Dwyer
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-10-27 00:00:00.000000000 Z
11
+ date: 2026-10-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: openfeature-sdk