Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Local evaluation buckets percentage splits with the server key, so results differ from Flagsmith

Aperta Adatta ai principianti
  • Qualcosa non va?
#109 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
75/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
ruby
Ambito
backend

Direzione di ricerca

Inizia da Client#get_identity_model in lib/flagsmith.rb, in particolare dalla costruzione della chiave composita collegata nell’issue, e segui come la chiave API dell’ambiente viene resa disponibile nella valutazione locale. Confronta la chiave risultante con il valore atteso client_key_account_two nella riproduzione. Aggiorna i test mirati per la valutazione locale dei Percentage Splits ed eseguili; il lavoro è completato quando l’SDK corrisponde al risultato dello split della dashboard.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

In local evaluation mode, the client builds the identity's composite key from the environment_key it was configured with:

https://github.com/Flagsmith/flagsmith-ruby-client/blob/f92f66df821b8a21565a412d5c2331c62e364b24/lib/flagsmith.rb#L343-L345

Local evaluation requires a server-side key, so environment_key is always ser.…. The composite key ends up as ser.<env key>_<identifier>, and that's what PERCENTAGE_SPLIT conditions hash, together with the segment ID.

Flagsmith itself appears to hash splits with the environment's client-side key, the api_key field of the environment document, giving <env key>_<identifier>. The two keys produce different percentages, so the SDK puts a different set of identities in every partial percentage split than the Flagsmith dashboard shows for the same identity and traits.

We found this when an identity that the dashboard showed in a 5% split segment evaluated as outside it in our app. Hashing <env key>_<identifier> gave 1.36 (in the percentage-based segment). Hashing ser.<env key>_<identifier>, what the SDK uses, gave 5.23 (outside the segment).

Reproduction
require "flagsmith"

document = {
  id: 1,
  api_key: "client_key",
  project: {
    id: 1, name: "Project", hide_disabled_flags: false,
    organisation: {id: 1, name: "Org", feature_analytics: false, stop_serving_flags: false, persist_trait_data: true},
    segments: [{
      id: 1, name: "60% rollout",
      rules: [{type: "ALL", rules: [], conditions: [{operator: "PERCENTAGE_SPLIT", value: "60", property_: "$.identity.key"}]}],
      feature_states: [{django_id: 2, featurestate_uuid: "segment-state", enabled: true, feature_state_value: nil,
                        feature: {id: 1, name: "rollout", type: "STANDARD"}, multivariate_feature_state_values: []}]
    }]
  },
  feature_states: [{django_id: 1, featurestate_uuid: "default-state", enabled: false, feature_state_value: nil,
                    feature: {id: 1, name: "rollout", type: "STANDARD"}, multivariate_feature_state_values: []}],
  identity_overrides: []
}

environment = Flagsmith::Engine::Environment.build(document)
handler = Object.new
handler.define_singleton_method(:environment) { environment }

client = Flagsmith::Client.new(
  environment_key: "ser.server_key",
  offline_mode: true,
  offline_handler: handler,
  enable_local_evaluation: true
)

client.get_identity_flags("account_two").is_feature_enabled("rollout")
# => false. Hashing "client_key_account_two" gives 57.05, which is inside the 60% split;
#    the SDK hashes "ser.server_key_account_two", which gives 62.53.
Expected

The SDK should match the dashboard and the other evaluation paths by building the composite key from environment.api_key.

Affected versions

4.1.1 and 4.3.0 (latest on RubyGems). It's also present in v5.0.0 and on main. In v5, Mappers::Identity.build_environment_context sets key: identity.composite_key, so the correct fallback in Segments::Evaluator.get_enriched_context, which builds "#{context[:environment][:key]}_#{identifier}" from the environment's api_key, never runs.

Suggested fix

In Client#get_identity_model, pass environment_api_key: environment.api_key instead of environment_key. We're running that change as a monkeypatch.

Lingua principale
Ruby
Stelle
12
Fork
6
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Flagsmith/flagsmith-ruby-client

Tutte le issue di Flagsmith/flagsmith-ruby-client

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.