From: "ioquatix (Samuel Williams)" Date: 2022-10-18T11:55:11+00:00 Subject: [ruby-core:110400] [Ruby master Feature#19062] Introduce `Fiber#locals` for shared inheritable state. Issue #19062 has been updated by ioquatix (Samuel Williams). ``` Warming up -------------------------------------- baseline 287.720k i/100ms locals-dup 229.210k i/100ms Calculating ------------------------------------- baseline 2.922M (�� 0.7%) i/s - 14.674M in 5.022671s locals-dup 2.289M (�� 0.4%) i/s - 11.460M in 5.007640s Comparison: baseline: 2921640.6 i/s locals-dup: 2288640.1 i/s - 1.28x (�� 0.00) slower ``` So in the context of creating a fiber, it's 30% slower. That's quite significant. > The problem is that with the fiber scheduler, the execution order might be different, so some codepaths will something run with a specific log level and something with another. That's terrible behavior. Yep, that's a fair point. > Then don't. Eagerly instantiate that pool, set it in the inherited registry and have that object be lazy. I fear this will cause people to use thread locals instead. ---------------------------------------- Feature #19062: Introduce `Fiber#locals` for shared inheritable state. https://bugs.ruby-lang.org/issues/19062#change-99708 * Author: ioquatix (Samuel Williams) * Status: Open * Priority: Normal * Assignee: ioquatix (Samuel Williams) ---------------------------------------- After exploring , I felt uncomfortable about the performance of copying lots of inheritable attributes. Please review that issue for the background and summary of the problem. ## Proposal Introduce `Fiber#locals` which is a hash table of local attributes which are inherited by child fibers. ```ruby Fiber.current.locals[:x] = 10 Fiber.new do pp Fiber.current.locals[:x] # => 10 end ``` It's possible to reset `Fiber.current.locals`, e.g. ```ruby def accept_connection(peer) Fiber.new(locals: nil) do # This causes a new hash table to be allocated. # Generate a new request id for all fibers nested in this one: Fiber[:request_id] = SecureRandom.hex(32) @app.call(env) end.resume end ``` A high level overview of the proposed changes: ```ruby class Fiber def initialize(..., locals: Fiber.current.locals) @locals = locals || Hash.new end attr_accessor :locals def self.[] key self.current.locals[key] end def self.[]= key, value self.current.locals[key] = value end end ``` See the pull request for the full proposed implementation. ## Expected Usage Currently, a lot of libraries use `Thread.current[:x]` which is unexpectedly "fiber local". A common bug shows up when lazy enumerators are used, because it may create an internal fiber. Because `locals` are inherited, code which uses `Fiber[:x]` will not suffer from this problem. Any program that uses true thread locals for per-request state, can adopt the proposed `Fiber#locals` and get similar behaviour, without breaking on per-fiber servers like Falcon, because Falcon can "reset" `Fiber.current.locals` for each request fiber, while servers like Puma won't have to do that and will retain thread-local behaviour. Libraries like ActiveRecord can adopt `Fiber#locals` to avoid the need for users to opt into different "IsolatedExecutionState" models, since it can be transparently handled by the web server (see for more details). We hope by introducing `Fiber#locals`, we can avoid all the confusion and bugs of the past designs. -- https://bugs.ruby-lang.org/ Unsubscribe: