quonfig 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 939842e745249a0ce6cee689801a6fe3a7cbdc56552ad88bdabaa0c36e79ef92
-  data.tar.gz: df5b171629c4b6c556f04b80a0035d5726c76929e78d11ba5382332d0e4b2293
+  metadata.gz: 7fb6a1cbb69335648d8e68194ef6c177360f575248942a145b214fae2e3a0bf6
+  data.tar.gz: 7782d66fe639d2b690932d7d3c7ed2becb793c0a18252ddd7988424eaf29fec5
 SHA512:
-  metadata.gz: 4c6822328fa6147d3816b404fe9543991d7095a5f663a2dc045f425113daba93f18da02e739c32dfce962858b00c190809acf4a62e56f1f049669bf813d8cdcd
-  data.tar.gz: 04a636c09573823cf0895c3cbbdcd2d9d79f22b875a877e55587244a2077bf1ae054007b729cc64bb8a2208e806fbdb962a7c55be38f2663c015b41d2685e09d
+  metadata.gz: 3ff89f7539988b7a95527fcc93b8fd2b1662ed52c664c87e9855c7f9e926877d4240c04c8703e62d93f93e81c3e28ce5540c27682bfcc65e306942d3985084aa
+  data.tar.gz: 8ea638dc75cadf24d41bfc6030748cf03116c359e69a3f8c03a72dea26496f01fe64395502a3f6dafd437c929f07ab81121b84c66cdafeb1feff38f58ba6a875

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.2.0 - 2026-10-29
+
+- **Changed (edge case): the `*_details` getters and `evaluate_details` report a value that cannot be parsed as `error_code: "PARSE_ERROR"` (qfg-wg1n).** A malformed ENV_VAR value (an int config whose env var is `"twelve"`, a duration env var `"PT5S garbage"`) and, on the typed getters, a malformed stored int, double or duration (`"twelve"`, `"abc"`, `"PT0.5H"`) were reported as `TYPE_MISMATCH`; they are now `PARSE_ERROR`, the code OpenFeature uses for this case, with the same `reason: "ERROR"`, nil value, variant and `flag_metadata` as before. A value of another type (`get_int_details` on a string config) is still `TYPE_MISMATCH`. The new constant is `Quonfig::EvaluationDetails::ERROR_PARSE_ERROR`. Only the error code on these failure paths changes: the plain getters, `get_or_raise` and the raised errors (`EnvVarParseError`, `TypeMismatchError`) are unchanged, and `evaluate_details` still returns a malformed stored value as stored with a success reason. Code that compared `error_code` to `TYPE_MISMATCH` to detect a malformed value should also accept `PARSE_ERROR`. quonfig-openfeature 2.3.0 already passes `PARSE_ERROR` straight through. Tests: `test/test_parse_error_details.rb`.
+
 ## 2.1.0 - 2026-10-29
 
 - **Added: `evaluate_details(key, context:)`, an untyped details read (qfg-177f).** It returns a `Quonfig::EvaluationDetails` whose `value` is the config's resolved value as stored, after ENV_VAR provision and decryption, with no type check or conversion: a duration comes back as its ISO 8601 text exactly as stored (`"PT90S"`, not milliseconds), a `string_list` as an Array, JSON as stored. The new `value_type` attribute names the stored type (`"duration"`, `"int"`, ...; `nil` when nothing resolved). Reason, variant, `flag_metadata`, error codes and telemetry are the same as the typed `*_details` getters, and it never raises. A malformed stored value (a duration `"30s"`) is returned as-is with a success reason; an unset or unparseable ENV_VAR is still `reason: "ERROR"`, as in the typed getters. Available on the client and on a `with_context` bound client. It matches sdk-go's `Client.EvaluateDetails` and is meant for OpenFeature providers and other callers that do their own typing. Existing getters are unchanged. Tests: `test/test_evaluate_details.rb`.

data/README.md

@@ -480,8 +480,11 @@ default only covers a missing key). For a typed read that raises, call the
 typed getter with no `default:` under `on_no_default: :raise`.
 
 The `*_details` getters (`get_int_details(key, context:)` and so on) never
-raise. They return `Quonfig::EvaluationDetails`; a wrong-type or malformed
-value is `reason: "ERROR"` with `error_code: "TYPE_MISMATCH"`.
+raise. They return `Quonfig::EvaluationDetails`; a value of another type is
+`reason: "ERROR"` with `error_code: "TYPE_MISMATCH"`, and a value that cannot
+be parsed as its declared type (a malformed ENV_VAR value, or a malformed
+stored int, double or duration) is `reason: "ERROR"` with
+`error_code: "PARSE_ERROR"`.
 `get_duration_details` carries the duration in integer milliseconds.
 
 To read a value without a type, use `evaluate_details(key, context:)`. It

data/lib/quonfig/client.rb

@@ -282,7 +282,10 @@ module Quonfig
     # carrying the OpenFeature-aligned resolution +reason+ ("STATIC",
     # "TARGETING_MATCH", "SPLIT", "DEFAULT", or "ERROR") plus an
     # +error_code+/+error_message+ on the error path. These methods never
-    # raise — exceptions are caught and rendered as ERROR details.
+    # raise — exceptions are caught and rendered as ERROR details. A value of
+    # another type is error_code TYPE_MISMATCH; a value that cannot be parsed
+    # as its declared type (a malformed ENV_VAR value, a malformed stored
+    # int, double or duration) is PARSE_ERROR.
 
     def get_bool_details(key, context: NO_DEFAULT_PROVIDED)
       build_details(key, :bool, context)
@@ -310,7 +313,7 @@ module Quonfig
 
     # Integer milliseconds in +value+ (qfg-2agi.27). A config whose valueType
     # is not duration is ERROR / TYPE_MISMATCH; a malformed value (stored or
-    # ENV_VAR) is ERROR with a nil value.
+    # ENV_VAR) is ERROR / PARSE_ERROR with a nil value.
     def get_duration_details(key, context: NO_DEFAULT_PROVIDED)
       build_details(key, :duration, context)
     end
@@ -2230,11 +2233,11 @@ module Quonfig
           )
         rescue Quonfig::Errors::EnvVarParseError => e
           # An ENV_VAR value that does not parse as the config's type is
-          # TYPE_MISMATCH, like a malformed stored value (as in sdk-go).
+          # PARSE_ERROR, like a malformed stored value (qfg-wg1n).
           return Quonfig::EvaluationDetails.new(
             value: nil,
             reason: Quonfig::EvaluationDetails::REASON_ERROR,
-            error_code: Quonfig::EvaluationDetails::ERROR_TYPE_MISMATCH,
+            error_code: Quonfig::EvaluationDetails::ERROR_PARSE_ERROR,
             error_message: e.message,
             variant: build_variant(Quonfig::EvaluationDetails::REASON_ERROR, nil, nil),
             flag_metadata: build_flag_metadata(nil, nil, nil, nil, nil)
@@ -2258,12 +2261,12 @@ module Quonfig
       begin
         coerced = expected_type.nil? ? stored_value(result) : typed_value(key, result, expected_type)
       rescue Quonfig::Errors::TypeMismatchError, Quonfig::Errors::EnvVarParseError => e
-        # A wrong-type value and a malformed one (the getter cannot produce
-        # a value of its type) are both TYPE_MISMATCH, as in sdk-go.
+        # A value of another type is TYPE_MISMATCH; a malformed one (a stored
+        # int "twelve", a duration "30s") is PARSE_ERROR (qfg-wg1n).
         return Quonfig::EvaluationDetails.new(
           value: nil,
           reason: Quonfig::EvaluationDetails::REASON_ERROR,
-          error_code: Quonfig::EvaluationDetails::ERROR_TYPE_MISMATCH,
+          error_code: details_error_code(e),
           error_message: e.message,
           variant: build_variant(Quonfig::EvaluationDetails::REASON_ERROR, nil, nil),
           flag_metadata: build_flag_metadata(config_id, config_type, nil, nil, nil)
@@ -2293,6 +2296,14 @@ module Quonfig
       )
     end
 
+    def details_error_code(error)
+      if error.is_a?(Quonfig::Errors::EnvVarParseError)
+        Quonfig::EvaluationDetails::ERROR_PARSE_ERROR
+      else
+        Quonfig::EvaluationDetails::ERROR_TYPE_MISMATCH
+      end
+    end
+
     # +result+'s resolved value in stored form (after ENV_VAR provision and
     # decryption) with no coercion or parse validation: a duration is its
     # ISO 8601 text as stored. Hashes and Arrays are copied so a caller

data/lib/quonfig/evaluation_details.rb

@@ -15,7 +15,10 @@ module Quonfig
   #
   # +error_code+ (only when reason == "ERROR") is one of:
   #   "FLAG_NOT_FOUND" — the key was unknown to the store
-  #   "TYPE_MISMATCH"  — the resolved value didn't satisfy the requested type
+  #   "TYPE_MISMATCH"  — the resolved value is of another type than the getter's
+  #   "PARSE_ERROR"    — the value cannot be parsed as its declared type: a
+  #                      malformed ENV_VAR value, or a malformed stored int,
+  #                      double or duration (qfg-wg1n)
   #   "PROVIDER_NOT_READY" — the client has no config yet (init continued
   #                          on code defaults, or a caught init failure)
   #   "GENERAL"        — any other failure
@@ -32,6 +35,7 @@ module Quonfig
 
     ERROR_FLAG_NOT_FOUND = 'FLAG_NOT_FOUND'
     ERROR_TYPE_MISMATCH  = 'TYPE_MISMATCH'
+    ERROR_PARSE_ERROR    = 'PARSE_ERROR'
     ERROR_GENERAL        = 'GENERAL'
     ERROR_PROVIDER_NOT_READY = 'PROVIDER_NOT_READY'
 

data/lib/quonfig/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Quonfig
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quonfig
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jeff Dwyer