Rails: Observar un modelo desde un plugin == problemas
November 16th, 2008 — 11:52 pmRails implementa el patron observador para permitir observar un modelo y responder así los diferentes estados que puede atravesar un objeto de dicho modelo.
Actualmente estoy trabajando en un proyecto donde es necesario que dos aplicaciones realizadas en Rails se comuniquen entre si mediante mediante Rest.Para conseguir esto, una de las aplicaciones incluye un plugin (proxy) en la otra.En este plugin se encarga de lo siguiente:
- Se definen los datos necesarios para esta comunicacion entre aplicaciones como así requiere ActiveResource::Base
- Se registra un observador que observara (valga la redundancia) uno de los modelos en la aplicación receptora el plugin
Antes de continuar con este post, tengo que confesar una cosilla, observar un modelo desde un plugin es un problema, si y solo si se hace en modo desarrollo.¿Y por qué?
Si no te interesa saber el porque de los problemas y has llegado hasta aqui buscando una solucion, con indicar a Rails que recargue los plugins en cada petición tendrás el asunto resuelto.
Para ello sigue los siguientes pasos:
1º. Indicar a Rails que quieres recargar los plugins
En config/environment.rb añade esta linea:
config.reload_plugins = true
Con esto lo único que hacemos en realidad, es evitar que el path /lib de cada plugin sea incluido en Dependencies.load_once_paths
Pero esto puede que no nos arregle nuestro problema y para muestra un ejemplo:
Arrancare el webrick en modo debug con un breakpoint en el método dispatch del fichero dispatcher.rb, método invocado para cada petición.
def dispatch(cgi = nil, session_options = CgiRequest::DEFAULT_SESSION_OPTIONS, output = $stdout) debugger new(output).dispatch_cgi(cgi, session_options) end
Arrancamos y enviamos una peticion:
=> Booting WEBrick... => Debugger enabled => Rails 2.1.1 application started on http://events.trabenet.local:3001 => Ctrl-C to shutdown server; call with --help for options [2008-11-16 21:37:24] INFO WEBrick 1.3.1 [2008-11-16 21:37:24] INFO ruby 1.8.7 (2008-08-08) [i686-darwin8] [2008-11-16 21:37:25] INFO WEBrick::HTTPServer#start: pid=1394 port=3001 /opt/local/lib/ruby/gems/1.8/gems/actionpack-2.1.1/lib/action_controller/dispatcher.rb:36 new(output).dispatch_cgi(cgi, session_options) (rdb:2)
El plugin del que tratamos declara una constante, EventObserver. Veamos si existe:
(rdb:2) EventObserver EventObserver (rdb:2) EventObserver.object_id 25840630
Perfecto.
Como en mi config/environment.rb indico que quiere recargar mis plugins, tenemos que:
(rdb:2) Dependencies.load_once_paths []
Y los load_paths son:
(rdb:2) pp Dependencies.load_paths ["/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/app/controllers/", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/app", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/app/models", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/app/controllers", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/app/helpers", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/config", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/vendor", "/opt/local/lib/ruby/gems/1.8/gems/rails-2.1.1/lib/../builtin/rails_info/", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/vendor/plugins/background/lib", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/vendor/plugins/localization-with-gettext/lib", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/vendor/plugins/localized_url_helpers/lib", "/opt/local/lib/ruby/gems/1.8/gems/mbleigh-acts-as-taggable-on-1.0.2/lib", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/vendor/plugins/thinking-sphinx/lib", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/vendor/plugins/trabenet-auth/lib", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/vendor/plugins/trabenet-core/lib", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/vendor/plugins/trabenet-people-proxy/lib", "/Users/madtrick/programacion/trabesoluciones/trabenet-sources/trabenet-events/vendor/plugins/trabenet_subscriptions_proxy/lib", "/opt/local/lib/ruby/gems/1.8/gems/will_paginate-2.2.2/lib"]
Por tanto en cada nueva petición los plugins serán candidatos a ser recargados.
Veamos si esto es así con otra petición:
127.0.0.1 - - [16/Nov/2008:22:00:21 CET] "POST /events.xml HTTP/1.1" 201 1 - -> /events.xml /opt/local/lib/ruby/gems/1.8/gems/actionpack-2.1.1/lib/action_controller/dispatcher.rb:36 new(output).dispatch_cgi(cgi, session_options) (rdb:11) EventObserver.object_id 25840630
Pues no, aquí no se recarga nada!! porque como podemos apreciar , el object_id de la constante es el mismo que el de la primera petición, es decir son el mismo objeto.
2º.Segundo paso de la solución,descargar las constantes del entorno
La explicación a que el objeto representado por EventObserver sea el mismo esto es la siguiente:
Para empezar hay que tener en cuanta que para que una constante definida en un plugin tenga validez en Rails es necesario que ocurra una de las siguientes posibilidades:
- Cuando se inicializa el entorno de Rails, para cada plugin se evalúa su fichero init.rb de forma que podemos utilizar llamadas a require para incluir el código contenido en el directorio /lib del plugin (y por tanto las constantes de este), en Rails.
- Que las constantes sean cargadas de forma dinámica como ya explique en este post, de forma que cada una de estas constantes incluidas de esta forma pasa a formar parte del array Dependencies.autoloaded_constants.Esto ultimo es importante.
La importancia de la forma en la que se carga una constante en Rails, reside en que es lo que se recarga en cada petición y que es lo que se descarga tras cada peticion.Tras cada petición (si estamos en modo de desarrollo) se enviara un mensaje a Dependencies.clear.
def clear log_call loaded.clear remove_unloadable_constants! end
La parte interesante de Dependencies.clear es la llamada al método remove_unloadable_constants!
def remove_unloadable_constants! autoloaded_constants.each { |const| remove_constant const } autoloaded_constants.clear explicitly_unloadable_constants.each { |const| remove_constant const } end
En este método se borra la constante indicada del modulo o clase correspondiente. Como se puede apreciar se borraran tanto las constante “autocargadas” como las indicadas explicitaménte en Dependencies.explicitly_unloadable_constants.
A pesar de haber indicado en nuestro environment.rb que queríamos recargar los plugins (config.reload_plugins=true); para cada petición no se volverá a evaluar el fichero init.rb de cada plugin y por tanto, si nuestras constantes se cargan en Rails mediante llamadas a require (no existirán en el array Dependencies.autoloaded_constants) ; estas no volverán a ser cargadas debido a que no habrá necesidad de ello al no haber sido descargadas en Dependencies.explicitly_unloadable_constants.Para solucionar esto podemos optar por una de estas opciones:
- No utilizar requires y dejar la carga de las constantes en manos de los mecanismos de Rails
- Hacer uso de Depedencies.explicitly_unloadable_constants, indicando en dicho array las constantes que queremos que se descarguen tras cada petición
Volviendo a nuestro ejemplo, probemos una de estas opciones.Utilizaremos Depedencies.explicitly_unloadable_constants.
En mi caso, defino las constantes que quiero que se descargen en el init.rb del plugin (por eso de tener todo juntito : ) ).
Dependencies.explicitly_unloadable_constants = 'EventObserver'
Y lo probamos de nuevo con webrick:
=> Booting WEBrick... => Debugger enabled => Rails 2.1.1 application started on http://events.trabenet.local:3001 => Ctrl-C to shutdown server; call with --help for options [2008-11-17 00:01:15] INFO WEBrick 1.3.1 [2008-11-17 00:01:15] INFO ruby 1.8.7 (2008-08-08) [i686-darwin8] [2008-11-17 00:01:15] INFO WEBrick::HTTPServer#start: pid=1442 port=3001 /opt/local/lib/ruby/gems/1.8/gems/actionpack-2.1.1/lib/action_controller/dispatcher.rb:36 new(output).dispatch_cgi(cgi, session_options) (rdb:2) EventObserver.object_id 25840560
Lanzamos otra petición.
127.0.0.1 - - [17/Nov/2008:00:01:17 CET] "POST /events.xml HTTP/1.1" 201 1 - -> /events.xml /opt/local/lib/ruby/gems/1.8/gems/actionpack-2.1.1/lib/action_controller/dispatcher.rb:36 new(output).dispatch_cgi(cgi, session_options) (rdb:11) EventObserver.object_id 27418300
Como se puede apreciar en esta ocasión son objetos distintos y por tanto realmente se recargado la constante.
Tras hacer esto, ya podemos observar con tranquilidad a nuestros modelos desde el plugin.
A partir de aquí voy a explicar el porque de la necesidad de recargar el contenido de nuestros plugins para poder observar a un modelo en modo de desarrollo.
Como explique antes, si no se recarga el contenido de nuestros plugins y en concreto la clase donde definimos el observador del modelo, tendremos un problema.¿Y por qué?
Primero , algunas cosillas a tener en consideración:
- Los Observadores en Rails utilizan el patrón Singleton
- Donde se instancian los observadores
Empezaremos por el segundo punto.
En Rails, existen dos puntos prefijados donde se instancian los observadores correspondientes a cada modelo.El primero es en el fichero initializer.rb en el metodo de clase process donde se invoca el metodo load_observers
def process ... load_observers end
Con load_observers como sigue,
def load_observers if gems_dependencies_loaded && configuration.frameworks.include?(:active_record) ActiveRecord::Base.instantiate_observers end end
En ActiveRecord::Base.instantiate_observers crearemos para cada modelo sus observadores y será aquí donde comienzen nuestros quebraderos de cabeza.
def instantiate_observers return if @observers.blank? @observers.each do |observer| if observer.respond_to?(:to_sym) # Symbol or String temp = observer.to_s.camelize.constantize temp.instance elsif observer.respond_to?(:instance) observer.instance else raise ArgumentError, "#{observer} must be a lowercase, underscored class name (or an instance of the class itself) responding to the instance method. Example: Person.observers = :big_brother # calls BigBrother.instance" end end end
POR TERMINAR, lo hare en otro post : )