Performance: simplify instantiate_record_from_json (hot path when parsing every Kill Bill response) and add an isolated benchmark

Aberta
#126 1 comentário 0 reações 1 responsável Ver no GitHub

@tungleduyxyz já está trabalhando nisso.

Desde 4/11/2026.

Avaliação

Esta issue ainda não foi avaliada.

Descrição

perf

Summary

Resource.instantiate_record_from_json turns each parsed JSON object into a model instance. It runs for every object of every Kill Bill response Kaui receives, recursively for nested objects. JFR profiling of Kaui on JRuby shows it as a large, hot method. The JRuby performance team recommends making it flatter (fewer blocks capturing surrounding variables) and smaller (the JVM optimizes small methods better), and adding an isolated benchmark of it together with Utils.underscore.

This complements killbill/killbill-client-ruby#125 (caching underscore/camelize). #125 removes the string-conversion cost; this issue is about the per-record and per-key work around it.

Where

resource.rb#L143-L180 at master (5d66ece, v4.0.11), called from from_json (#L122-L140) right after JSON.parse.

What it does today:

When Work Cost
per record resource_class.ancestors.select { |a| !@@attribute_names[a.name].nil? } walks and allocates the ancestor list for every record, although it only depends on the class
per key name = Utils.underscore name 3 regex gsub! + tr! (see #125)
per key kb_ancestors.each { ... @@attribute_names[ancestor.name][name.to_sym] ... } a block, ancestor.name and to_sym lookups per key, to find has_one/has_many metadata
per key, nested value.each { ... instantiate_record_from_json(type, val) ... } into a new array nested blocks capturing newValue, type and more
per key record.send("#{Utils.underscore name}=", value) rescue nil underscores the name a second time, allocates the setter string, and uses rescue nil as control flow

About rescue nil: when Kill Bill returns a field the model doesn't declare, the setter call raises NoMethodError and the exception is swallowed. Exceptions are expensive on the JVM (backtrace capture), so if this happens on a common path it costs real time. Not verified yet how often it happens with current Kill Bill (0.25.x) payloads; the benchmark below should measure it.

Proposed changes

  1. Per-class lookup table, built once and cached (thread-safe): json_key => [setter_symbol, cardinality, type] (or nil for unknown keys). Each key then costs a single hash lookup: no ancestors walk, no underscore, no string interpolation.
  2. Unknown keys: look them up in that table (or use respond_to? once per class/key) instead of raising and rescuing NoMethodError. Keep the current lenient behaviour (unknown fields are ignored).
  3. Split into small methods: e.g. assign_attribute, build_many, build_one, with no blocks capturing outer locals in the hot loop (plain each over the hash and arrays).
  4. Keep the public behaviour identical, including inheritance of has_one/has_many declarations through ancestors, and nested Resources.

Benchmark (requested by the perf team)

Add a benchmark script, e.g. benchmark/from_json.rb, using benchmark-ips and allocation counts, that runs from_json on real Kill Bill payloads:

  • an account with balance
  • an invoice list
  • a payment list
  • the AccountTimeline of a large account (the heaviest Kaui page)

Realistic payloads can be captured from our perf environment, which has 500 seeded accounts, including accounts with about 300 invoices and payments each. Run on JRuby 10 and CRuby, before and after.

Acceptance criteria

  • Existing specs pass; new specs for nested has_one/has_many, inherited attribute metadata, and unknown fields being ignored
  • Benchmark script committed, with before/after results (iterations/s and allocated objects) on JRuby 10 and CRuby
  • A measurement of how often the rescue nil path is hit on the real payloads above
  • Follow-up JFR profile of Kaui shows instantiate_record_from_json shrinking accordingly

Related

  • killbill/killbill-client-ruby#125: cache Utils.underscore / camelize (do first, or together)
  • killbill/killbill-admin-ui-standalone#136: json gem 3.x evaluation (faster JSON parsing)
  • killbill/killbill-cloud#349 (invokedynamic) and killbill/killbill-admin-ui-standalone#137 (GC comparison and JFR recordings): the rest of the same profiling round
  • Load-test harness and perf notes: killbill-admin-ui-standalone, branch performance-test, perf/
Linguagem predominante
Ruby
Estrelas
26
Forks
27
Merge médio
4d 18h
PRs com merge (30d)
4

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Issues semelhantes

Mais issues de Ruby

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.