ruby-grape / grape
97%
master: 97%

LAST BUILD BRANCH: router-compile-registered-methods
DEFAULT BRANCH: master
Repo Added
Files 169
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH perf/endpoint-helpers-prototype
branch: perf/endpoint-helpers-prototype
CHANGE BRANCH
x

coverage: 96.973% (+0.02%) from 96.95%
33600352030

Pull #2872

github

ericproulx 
Include endpoint helpers once instead of on every request

Helpers are instance methods on the endpoint, because the route block is bound
to the endpoint and runs against it. They are also per-endpoint — including
them into Grape::Endpoint itself would leak one API's helpers into every
endpoint in the process — so they went onto the per-request copy:

    def call(env)
      dup.call!(env)
    end

    def call!(env)
      ...
      singleton_class.include(@helpers) if @helpers

That had to happen per request rather than once: Object#dup deliberately does
not carry a singleton class over, so including the helpers on the shared
endpoint would never reach the copies that actually serve requests.

The cost is not the include. `dup` plus `include` measures ~510 ns against
~110 ns for `dup` alone, which would be under 2% of a request. The expense is
that `singleton_class` on a fresh copy *creates a class*, and a class nothing
has called through yet has no method cache. Counting allocations: the dup, its
singleton class and the iclasses are 4 objects, and the first call to each
distinct method through that class costs 3 more — paid again on the next
request, for every helper, for the route block, and for every DSL method the
endpoint answers.

Include them once, at compile! time, into a subclass owned by this endpoint,
and copy the endpoint's state onto an instance of it. Each request then copies
an object whose class has been warm since boot, and request handling no longer
mutates a class at all.

On a small API with helpers, params and validations (median of 9 runs, Ruby
4.0.5, single-threaded Benchmark.ips):

                          YJIT                   no-YJIT          objects/req
    GET    40,853 -> 51,605  (+26%)   19,574 -> 21,368  (+9%)      154 -> 121
    POST   40,045 -> 51,009  (+27%)   19,657 -> 21,711  (+10%)     157 -> 123

An endpoint that declares no helpers is its own prototype: throughput and
allocation counts there are unchanged.

On... (continued)
Pull Request #2872: Include endpoint helpers once instead of on every request

1237 of 1330 branches covered (93.01%)

Branch coverage included in aggregate %.

10 of 10 new or added lines in 1 file covered. (100.0%)

3921 of 3989 relevant lines covered (98.3%)

27245.97 hits per line

Relevant lines Covered
3989 RELEVANT LINES 3921 COVERED LINES
27245.97 HITS PER LINE
Source Files on perf/endpoint-helpers-prototype

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
33600352030 perf/endpoint-helpers-prototype Include endpoint helpers once instead of on every request Helpers are instance methods on the endpoint, because the route block is bound to the endpoint and runs against it. They are also per-endpoint — including them into Grape::Endpoint itself ... Pull #2872 ericproulx github
96.97
33553892511 perf/endpoint-helpers-prototype Include endpoint helpers once instead of on every request Helpers are instance methods on the endpoint, because the route block is bound to the endpoint and runs against it. They are also per-endpoint — including them into Grape::Endpoint itself ... Pull #2872 ericproulx github
96.97
33415163133 perf/endpoint-helpers-prototype Merge branch 'master' into perf/endpoint-helpers-prototype Pull #2872 web-flow github
96.97
33380104055 perf/endpoint-helpers-prototype Include endpoint helpers once instead of on every request Helpers are instance methods on the endpoint, because the route block is bound to the endpoint and runs against it. They are also per-endpoint — including them into Grape::Endpoint itself ... Pull #2872 ericproulx github
97.0
33379659757 perf/endpoint-helpers-prototype Include endpoint helpers once instead of on every request Helpers are instance methods on the endpoint, because the route block is bound to the endpoint and runs against it. They are also per-endpoint — including them into Grape::Endpoint itself ... Pull #2872 ericproulx github
97.0
33379390620 perf/endpoint-helpers-prototype Include endpoint helpers once instead of on every request Helpers are instance methods on the endpoint, because the route block is bound to the endpoint and runs against it. They are also per-endpoint — including them into Grape::Endpoint itself ... Pull #2872 ericproulx github
97.0
33378892198 perf/endpoint-helpers-prototype Include endpoint helpers once instead of on every request Helpers are instance methods on the endpoint, because the route block is bound to the endpoint and runs against it. They are also per-endpoint — including them into Grape::Endpoint itself ... Pull #2872 ericproulx github
97.0
33378858587 perf/endpoint-helpers-prototype Merge 84c885578 into 4b32ecce3 Pull #2872 web-flow github
97.0
33378832180 perf/endpoint-helpers-prototype Include endpoint helpers once instead of on every request Helpers are instance methods on the endpoint, because the route block is bound to the endpoint and runs against it. They are also per-endpoint — including them into Grape::Endpoint itself ... push ericproulx github
97.0
See All Builds (3635)