aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_dispatch/routing
Commit message (Collapse)AuthorAgeFilesLines
...
* use the strategy pattern to match request verbsAaron Patterson2015-08-171-10/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Rather than building a regexp for every route, lets use the strategy pattern to select among objects that can match HTTP verbs. This commit introduces strategy objects for each verb that has a predicate method on the request object like `get?`, `post?`, etc. When we build the route object, look up the strategy for the verbs the user specified. If we can't find it, fall back on string matching. Using a strategy / null object pattern (the `All` VerbMatcher is our "null" object in this case) we can: 1) Remove conditionals 2) Drop boot time allocations 2) Drop run time allocations 3) Improve runtime performance Here is our boot time allocation benchmark: ```ruby require 'action_pack' require 'action_dispatch' route_set = ActionDispatch::Routing::RouteSet.new routes = ActionDispatch::Routing::Mapper.new route_set result = ObjectSpace::AllocationTracer.trace do 500.times do routes.resources :foo end end sorted = ObjectSpace::AllocationTracer.allocated_count_table.sort_by(&:last) sorted.each do |k,v| next if v == 0 p k => v end __END__ Before: $ be ruby -rallocation_tracer route_test.rb {:T_SYMBOL=>11} {:T_REGEXP=>4017} {:T_STRUCT=>6500} {:T_MATCH=>12004} {:T_DATA=>84092} {:T_OBJECT=>99009} {:T_HASH=>122015} {:T_STRING=>216652} {:T_IMEMO=>355137} {:T_ARRAY=>441057} After: $ be ruby -rallocation_tracer route_test.rb {:T_SYMBOL=>11} {:T_REGEXP=>17} {:T_STRUCT=>6500} {:T_MATCH=>12004} {:T_DATA=>84092} {:T_OBJECT=>99009} {:T_HASH=>122015} {:T_STRING=>172647} {:T_IMEMO=>355136} {:T_ARRAY=>433056} ``` This benchmark adds 500 resources. Each resource has 8 routes, so it adds 4000 routes. You can see from the results that this patch eliminates 4000 Regexp allocations, ~44000 String allocations, and ~8000 Array allocations. With that, we can figure out that the previous code would allocate 1 regexp, 11 strings, and 2 arrays per route *more* than this patch in order to handle verb matching. Next lets look at runtime allocations: ```ruby require 'action_pack' require 'action_dispatch' require 'benchmark/ips' route_set = ActionDispatch::Routing::RouteSet.new routes = ActionDispatch::Routing::Mapper.new route_set routes.resources :foo route = route_set.routes.first request = ActionDispatch::Request.new("REQUEST_METHOD" => "GET") result = ObjectSpace::AllocationTracer.trace do 500.times do route.matches? request end end sorted = ObjectSpace::AllocationTracer.allocated_count_table.sort_by(&:last) sorted.each do |k,v| next if v == 0 p k => v end __END__ Before: $ be ruby -rallocation_tracer route_test.rb {:T_MATCH=>500} {:T_STRING=>501} {:T_IMEMO=>1501} After: $ be ruby -rallocation_tracer route_test.rb {:T_IMEMO=>1001} ``` This benchmark runs 500 calls against the `matches?` method on the route object. We check this method in the case that there are two methods that match the same path, but they are differentiated by the verb (or other conditionals). For example `POST /users` vs `GET /users`, same path, different action. Previously, we were using regexps to match against the verb. You can see that doing the regexp match would allocate 1 match object and 1 string object each time it was called. This patch eliminates those allocations. Next lets look at runtime performance. ```ruby require 'action_pack' require 'action_dispatch' require 'benchmark/ips' route_set = ActionDispatch::Routing::RouteSet.new routes = ActionDispatch::Routing::Mapper.new route_set routes.resources :foo route = route_set.routes.first match = ActionDispatch::Request.new("REQUEST_METHOD" => "GET") no_match = ActionDispatch::Request.new("REQUEST_METHOD" => "POST") Benchmark.ips do |x| x.report("match") do route.matches? match end x.report("no match") do route.matches? no_match end end __END__ Before: $ be ruby -rallocation_tracer runtime.rb Calculating ------------------------------------- match 17.145k i/100ms no match 24.244k i/100ms ------------------------------------------------- match 259.708k (± 4.3%) i/s - 1.303M no match 453.376k (± 5.9%) i/s - 2.279M After: $ be ruby -rallocation_tracer runtime.rb Calculating ------------------------------------- match 23.958k i/100ms no match 29.402k i/100ms ------------------------------------------------- match 465.063k (± 3.8%) i/s - 2.324M no match 691.956k (± 4.5%) i/s - 3.469M ``` This tests tries to see how many times it can match a request per second. Switching to method calls and string comparison makes the successful match case about 79% faster, and the unsuccessful case about 52% faster. That was fun!
* switch Route constructors and pass in the regexpAaron Patterson2015-08-171-9/+15
| | | | | We don't need to add and delete from the conditions hash anymore, just pass the regexp directly to the constructor.
* introduce an alternate constructor for Route objectsAaron Patterson2015-08-171-1/+1
| | | | | I want to change the real constructor to take a particular parameter for matching the request method
* default pattern to use a joined stringAaron Patterson2015-08-171-1/+3
| | | | | The string we create is almost always the same, so rather than joining all the time, lets join once, then reuse that string everywhere.
* move route allocation to a factory method on the mapping objectAaron Patterson2015-08-151-0/+12
| | | | | | I would like to change the signature of the Route constructor. Since the mapping object has all the data required to construct a Route object, move the allocation to a factory method.
* only process `via` onceAaron Patterson2015-08-151-5/+3
| | | | | we can directly turn it in to a regular expression here, so we don't need to test its value twice
* only keep one hash of named routesAaron Patterson2015-08-141-1/+2
| | | | | The outer router object already keeps a hash of named routes, so we should just use that.
* rm add_route2Aaron Patterson2015-08-141-1/+1
| | | | | refactor the tests with a backwards compatible method call so we can rm add_route2 from the journey router
* pass pass the mapping object down the add_route stackAaron Patterson2015-08-142-53/+60
| | | | | then we can let the mapping object derive stuff that the Route object needs.
* pass the mapping object to build_routeAaron Patterson2015-08-142-10/+10
| | | | | now that we aren't doing options manipulations, we can just pass the mapping object down and read values from it.
* remove `process_path`Aaron Patterson2015-08-141-6/+2
| | | | | since we've extracted the `to` initialization, there's no need for `process_path`
* explicitly return nil from `get_to_from_path`Aaron Patterson2015-08-141-3/+3
| | | | | | if `to` was initialized, this method would return, so we can eliminate the to ||= in the conditional. Finally, let's return a nil in the else block so that it's explicit that this method can return nil
* extract method on determining :to from the pathAaron Patterson2015-08-141-5/+9
| | | | Eventually we'll pull this up and delete `process_path`.
* deprecate passing a string for both the beginning path and :path optionAaron Patterson2015-08-141-1/+16
|
* rm path_params methodAaron Patterson2015-08-141-5/+1
| | | | | | We don't need a method for something like this. I want to pull this up the stack as well and move the module + :controller ArgumentError up the stack as well
* extract method on wildcard path parameter handlingAaron Patterson2015-08-141-6/+11
|
* pass the path ast downAaron Patterson2015-08-142-5/+3
| | | | | now we don't need to add it to a hash and delete it from the hash later just to pass it around
* pull up path parsingAaron Patterson2015-08-141-10/+6
| | | | | `add_route` needs the AST, so rather than shove it in a hash and delete later, lets move parsing up the stack so we can pass down later
* stop adding path_info to the conditions hashAaron Patterson2015-08-142-2/+0
| | | | we don't need to keep adding it and deleting if from hashes.
* pull up path normalization.Aaron Patterson2015-08-141-18/+18
| | | | | Eventually I want to pull up AST generation so that we don't have to add it to the `conditions` hash.
* `build_path` doesn't need the path variable anymoreAaron Patterson2015-08-131-2/+2
| | | | | It just constructs a Path::Pattern object with the AST that it already has
* remove StrexpAaron Patterson2015-08-131-7/+1
| | | | | This was a useless object. We can just directly construct a Path::Pattern object without a Strexp object.
* pass anchor directly to `Pattern`Aaron Patterson2015-08-131-3/+2
| | | | | the caller already has it, there is no reason to pack it in to an object and just throw that object away.
* we already have access to the AST, so just use itAaron Patterson2015-08-131-3/+3
|
* remove default arguments that aren't usedAaron Patterson2015-08-131-1/+1
| | | | | we always pass all parameters, so there is no reason to provide default arguments.
* pull up options_constrants extractionAaron Patterson2015-08-131-16/+15
|
* remove `as`Aaron Patterson2015-08-131-8/+7
| | | | the caller already has access to `as`, so we can stop passing it around.
* remove anchor from mappingAaron Patterson2015-08-131-8/+7
| | | | | | the same value that is extracted from the options hash earlier is returned, so we don't need to pass it in in the first place. The caller already has the data, so stop passing it around.
* pull `anchor` extraction upAaron Patterson2015-08-131-17/+16
| | | | | this way we don't have to mutate the options hash so far away from where the user passed it in
* raise if `anchor` is passed to `scope`Aaron Patterson2015-08-131-0/+4
| | | | | | The `anchor` parameter [is overridden](https://github.com/rails/rails/blob/b4b4a611d0eb9aa1c640c5f521c6a43bf2a65bab/actionpack/lib/action_dispatch/routing/mapper.rb#L1528) unless it is directly passed to `match`, so setting it in a scope must be a mistake.
* remove the `add_request_method` methodAaron Patterson2015-08-121-7/+3
| | | | | I didn't like this method because it mutates the parameters. Now that the method is so small, just push it up to `initialize`
* remove side effects in `normalize_defaults`Aaron Patterson2015-08-121-8/+3
| | | | | now the `@defaults` variable doesn't need to be set before calling `normalize_defaults`
* remove unnecessary deletesAaron Patterson2015-08-121-4/+0
| | | | | | | These three options are stored in the `scope` chain outside of the options hash. If they are in the options hash, then someone passed them in to `match` and they don't really do anything. So lets remove the code.
* pull `format` out of the options hashAaron Patterson2015-08-121-11/+10
| | | | | remove `format` from the options hash in the scope chain so that we don't need to remove it later
* pull `formatted` up the stackAaron Patterson2015-08-121-14/+13
| | | | this reduces the number of times we have to mutate the options hash.
* store `via` outside the options hashAaron Patterson2015-08-121-3/+6
| | | | | Now we don't have to manually remove this from the options hash since the scope stores it outside of "options"
* don't mutate the caller's variablesAaron Patterson2015-08-121-14/+15
| | | | | | | Remove the `options` reader from `Resource` because nobody needs to see that hash. Also remove mutations on the options hash in `apply_common_behavior_for` because leaving the side effects in that method makes it difficult to understand what is going on in the caller.
* store `:only` and `:except` outside the normal options hashAaron Patterson2015-08-121-9/+8
| | | | | | these two keys have a different merge strategy, and they also just get removed from the options hash later in the code. If we store them in a separate place, then we don't need to remove them later
* add a method to `Scope` for getting mapping optionsAaron Patterson2015-08-121-2/+8
| | | | | Eventually we don't want to expose the "options" hash from scope, only read values from it. Lets start by adding a reader method.
* pull via checking up to via extractionAaron Patterson2015-08-121-11/+15
| | | | | now we don't need to construct a Mapping object just to get an ArgumentError if there is no `via` parameter provided.
* pull `via` all the way out of `add_route`Aaron Patterson2015-08-121-11/+12
|
* fix via handling when it's in a scopeAaron Patterson2015-08-121-1/+1
|
* pull `via` extraction upAaron Patterson2015-08-121-5/+6
| | | | | | We're going to try pulling this up further, and check `via` validity sooner. This way we don't have to do a bunch of processing on `options` hashes only to find out that the route is incorrect
* simplify `split_constraints`Aaron Patterson2015-08-121-12/+11
| | | | | If we do the Regexp verification in a second method, then the `split_constraints` method gets much easier.
* remove side effects from `normalize_format`Aaron Patterson2015-08-121-9/+13
|
* switch === to case / whenAaron Patterson2015-08-121-3/+4
|
* make `split_constraints` more functional.Aaron Patterson2015-08-121-14/+13
| | | | | | I don't want `split_constraints` to mutate any instance variables. That way it's easier to move the method around and understand what it does (it has no side effects)
* make `constraints` more functionalAaron Patterson2015-08-121-8/+10
| | | | | I don't want to rely on mutating ivars. This gives me more freedom when refactoring
* only call `split_constraints` onceAaron Patterson2015-08-111-4/+4
|
* only do is_a? checks on `options_constraints` onceAaron Patterson2015-08-111-16/+9
| | | | we don't need to do it so many times.
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-11 09:31:13 +0000