For the past five days I have been struggling with a bug in the route code in rails 1.2.3. I finally monkey patched url_for to essentially force it to do the obvious.
\nIn this blog post, I describe the bug and how I reproduced it and then the patch to work around the bug.
\nThere is a 10% chance that the routes is actually working and I just do not understand it. I read in the Agile book something about routes trying to use the shortest URL where possible – but the problem is that I have these long URLs to pass bits of session-like information around between my ajax calls – particularly when I want to go cross domain with my Ajax (i.e. I want to use a Rails tool from one server included into a web page from another server where cookies and session information will not be usable).
\nThe bug comes down to when I call something with a long url with lots of stuff defined and then I generate a new url adding an id which is always at the end of the routes, url_for decides to “forget” the stuff that was to the left of it in the incoming request URL. Changing action only generates the *right* url while changing the action and id generates the wrong URL.
\nMy Urls have three basic forms
\n\/imsti.fe828-12345-bfea.1.right-content\/comments\/ajaxstart
\n\/ajax.1.right-content\/comments\/ajaxstart
\n\/comments\/ajaxstart
\nThe first two are for use in divs and never shown to the user. The imsti one both establishes a session and sets up the context and div name when the tool is being used cross-domain. The second is used when you are not going cross-domain and cookies are available to establish session because the ajax and the enclosing container are coming from the same server – so incoming ajax requests get the cookies.<\/p>\n
\nHere is my routes.rb – the three routes in question are the ones that freak Rails url generation out – even though I never use not generate Urls with the imsti prefix – other URLs are incorrectly generated as you will see in this short sad story.
\nmap.connect ”, :controller => “portal”
\n# Problem causing routes
\nmap.connect ‘imsti.:imssession.:context.:div\/:controller\/:action\/:id.:format’
\nmap.connect ‘imsti.:imssession.:context.:div\/:controller\/:action\/:id’
\nmap.connect ‘imsti.:imssession.:context.:div\/:controller\/:action’
\n#
\nmap.connect ‘ajax.:context.:div\/:controller\/:action\/:id.:format’
\nmap.connect ‘ajax.:context.:div\/:controller\/:action\/:id’
\nmap.connect ‘ajax.:context.:div\/:controller\/:action’
\nmap.connect ‘:controller\/:action\/:id.:format’
\nmap.connect ‘:controller\/:action\/:id’
\nmap.connect ‘:controller\/:action’
\nThe bug happens when I go to a page with a Url like this
\n\/ajax.1.right-content\/comments\/ajaxstart
\nAnd then in the view for this page I do this:
\n<%= link_to_remote ‘view’, :update=> portal_get_div,
\n:url => { :action => ‘view’, :id => comment.id } %>
\nSimple enough – I am changing the action and adding an ID – it should inherit the rest since in all my routes id and action are at the end.
\nHere is the problem – when I do not have the three imsti routes in my routes.rb all works well – the link_to_remote generates this url:
\n\/ajax.1.right-content\/comments\/view\/1
\nIf I add the three imsti prefixed routes to my routes.rb the same code when called from the same url:
\n\/ajax.1.right-content\/comments\/ajaxstart
\nMakes this URL:
\n\/comments\/view\/1
\nAargh! And on the same page in the same view, this code:
\n<%= link_to_remote ‘Manage’, :update=> portal_get_div,
\n:url => { :action => ‘manage’ } %>
\nMakes beautiful URLs like this regardless of what version of the routes.rb I use:
\n\/ajax.1.right-content\/comments\/manage
\nSo what the heck is happening – it works for action and fails when you do action+id – clearly the addition of an :id is triggering some deep stupid behavior in the url_for.
\nA key here is that I am never calling nor using a route that starts with imsti – the mere adding of the routes causes things to break.
\nI have played for hours and at one point removed my three routes and had a single route that would cause the evil behavior. I lost the exact single route that broke it – but it looked something like this:
\nmap.connect ‘routesbiteme\/:controller\/:action’
\nIt had an action but no id – and yet it caused url generation to blow its brains out. I need to look at the Rails source code. One day I will download my own copy and start hacking on Rails – but I will save that for when I have more time.
\nSo here is the monkey patch to fix it:<\/p>\n
\nmodule ApplicationHelper\ninclude Osids\ninclude Portal\nprotected\n# This is inspired by another monkey patch for support in browsers\n# without cookies - but since cookie_only >= false seems broken\n# that patch while useful to read is not much help\n#\n# http:\/\/www.edgesoft.ca\/blog\/read\/2\n#\n# Funny - sometimes options is a string - in this view code\n#\n# <% form_remote_for :umap, @user, :update=> portal_get_div,\n# :url => { :action => \"add\" } do |f| %>\n#\n# options comes in as a string like this:\n#\n# \/ajax.1.main-content\/users\/add\n#\n# I am sure this is yet another bug. But we need to simply\n# not patch the Hash unless it is really a hash\n#\ndef url_for(options = {}, *parameters_for_method_reference)\nif options.class == Hash\nif options[:div] == nil && params[:div] != nil\noptions[:div] = params[:div]\nend\nif options[:context] == nil && params[:context] != nil\noptions[:context] = params[:context]\nend\nif options[:imssession] == nil && params[:imssession] != nil\noptions[:imssession] = params[:imssession]\nend\nend\nsuper\nend\nend\n<\/pre>\n<\/font>
\nEffectively if the parameters are on the request, and not in options, I force them into options. Somehow this convinces the recalcitrant url generation to really see the parameters.
\nI wasted about 15 hours on this one – I guess I learned something from it. I cannot wait to see the ugly code in url generation or secret undocumented back-door feature that broke this.
\nP.S. I am still struggling with how to set the Rails session id from a URL – my other reason to be peeved at the Rails folks – don’t get me started on cookie_only and Rails developers rushing to put in security fixes without thinking about real impact. For now I have a hack to do IMS TI sessions in my own framework without using Rails sessions – to get on to cross-domain Ajax testing.<\/p>\n","protected":false},"excerpt":{"rendered":"
For the past five days I have been struggling with a bug in the route code in rails 1.2.3. I finally monkey patched url_for to essentially force it to do the obvious. In this blog post, I describe the bug and how I reproduced it and then the patch to work around the bug. There […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-387","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/posts\/387","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/comments?post=387"}],"version-history":[{"count":1,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/posts\/387\/revisions"}],"predecessor-version":[{"id":2490,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/posts\/387\/revisions\/2490"}],"wp:attachment":[{"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/media?parent=387"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/categories?post=387"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.dr-chuck.com\/csev-blog\/wp-json\/wp\/v2\/tags?post=387"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}