OSGI/Rails/Equinox/Pax-Web - no such file to load -- /WEB-INF/config/environment.rb

[viphe]

Hi,

I am currently trying to POC the deployment of a Rails app as an OSGI bundle in Equinox using Pax-Web + Jetty to automatically load the WAR file generated with Warble.

I achieved to load the Warble-generated bundle and I am now facing the following error:

--- Context Init Parameters:
public.root = /
rails.env = production
webapp.context = dummy

--- Backtrace
LoadError: no such file to load -- /WEB-INF/config/environment.rb
              load at org/jruby/RubyKernel.java:1081
  load_environment at classpath:/jruby/rack/rails/environment2.rb:25
  load_environment at classpath:/jruby/rack/rails_booter.rb:83
            (root) at <script>:1

--- RubyGems
Gem.dir: /WEB-INF/gems/
Gem.path:
/WEB-INF/gems
/Users/pvosges/.rvm/gems/jruby-1.7.8
/Users/pvosges/.rvm/gems/jruby-1.7.8@global
/WEB-INF/gems/
Activated gems:

--- Bundler
undefined method `bundle_path' for Bundler:Module

--- JRuby-Rack Config
compat_version =
default_logger = org.jruby.rack.logging.StandardOutLogger@5e4f92de
equals = <error: >
err = org.apache.felix.gogo.runtime.threadio.ThreadPrintStream@d222e6e
filter_adds_html = true
filter_verifies_resource = false
ignore_environment = false
initial_memory_buffer_size =
initial_runtimes =
jms_connection_factory =
jms_jndi_properties =
logger = org.jruby.rack.logging.ServletContextLogger@13b9beab
logger_class_name = servlet_context
logger_name = jruby.rack
maximum_memory_buffer_size =
maximum_runtimes =
num_initializer_threads =
out = org.apache.felix.gogo.runtime.threadio.ThreadPrintStream@7fb22024
rackup =
rackup_path =
rewindable = true
runtime_arguments =
runtime_environment =
runtime_timeout_seconds =
serial_initialization = false
servlet_context = ServletContext@HttpServiceContext{httpContext=WebAppHttpContext{DummyApp - 32}}
throw_init_exception = false

--- $LOAD_PATH:
classpath:/META-INF/jruby.home/lib/ruby/1.9/site_ruby
classpath:/META-INF/jruby.home/lib/ruby/shared
classpath:/META-INF/jruby.home/lib/ruby/1.9

Is it even possible to use a Warble-generated WAR without exploding it?

Note: might be related to #44.

--- Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/4293889-osgi-rails-equinox-pax-web-no-such-file-to-load-web-inf-config-environment-rb?utm_campaign=plugin&utm_content=tracker%2F136961&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F136961&utm_medium=issues&utm_source=github).

[mkristian]

currently embedded gems as well Dir globs will not work with warbler and
jruby-rack

the current state of how OSGI is working can be seen here:

https://github.com/jruby/jruby/tree/jruby-1_7/maven/jruby/src/it/osgi_all_inclusive
https://github.com/jruby/jruby/tree/jruby-1_7/maven/jruby-complete/src/it/osgi_many_bundles_with_embedded_gems

which uses a slightly different ScriptingContainer then jruby-rack. once we
have a snapshot for jruby-rack using the IsolatedScriptingContainer we
could look into added a integration-test in jruby with web-archive-bundles

please be free to comment on the above integration tests - any ideas to
improve things are welcome (I was not able to get them work with
knopflerfish)

after this we can have a look at warbler to help to bundle things the right
way.

[viphe]

I actually have the same behavior when installing from an exploded WAR file.

The problem is that, inside OSGI, ServletContext.getRealPath does not work as expected and do not return the file locations. However, there seems to be a path when leveraging Equinox's FileLocator (I think its bundle can be used in any OSGI environment).

In the webapp manifest, one needs:

Require-Bundle: org.eclipse.equinox.common

(Note that there is another way to import, using ImportPackage: org.eclipse.core.runtime; common=split.)

Then, hacking META-INF/init.rb (paste at the end):

OsgiFileLocator ||=
  begin
    Java::OrgEclipseCoreRuntime::FileLocator
  rescue NameError
    nil
  end

if OsgiFileLocator && $servlet_context

  def get_osgi_real_path(path)
    real_path_url = $servlet_context.getResource(path)
    OsgiFileLocator.toFileURL(real_path_url).path
  end

  ENV['GEM_HOME'] = get_osgi_real_path('/WEB-INF/gems')
  ENV['BUNDLE_GEMFILE'] = get_osgi_real_path('/WEB-INF/Gemfile')
  $LOAD_PATH.unshift get_osgi_real_path('/WEB-INF')
end

Et voila, my simple Sinatra works!

At this point, for me, working with an exploded WAR is quite fine (in some ways better).

Any idea as to the best way to integrate my code automatically to init.rb (I don't think I would be quite ready to turn it into a pull request)?

[viphe]

^ I guess I could fork Warbler and change the template.

[viphe]

You will find a working implementation of the above FileLocator there: https://github.com/viphe/warbler/tree/exploded-osgi-bundles.

It is not necessarily the best way to implement this as, ideally, one would like to also customize META-INF/MANIFEST.MF automatically in order to include the proper OSGi headers. I suppose a wab trait extending war might make sense.

[mkristian]

this works just for equinox ! what about felix and knopflerfish ?

well, equinox is start. yes, a trait for the osgi is the way to go.

[viphe]

Just POC-ing. I am relatively new to jruby-rack, warbler and OSGi. My approaches might be all wrong.

The "solution" above uses a bundle from the Equinox project, but I read it can be used in any OSGi environment (same way I'm using Felix's command shell bundle inside Equinox).

Sorry for throwing a lot of random info at you. Hopefully, it can be helpful to you, me or someone else at some point.

[mkristian]

do not worry about the FileLocator the current implementation is a good
start, we can look into this later.

setting up the META-INF/... data would be great. usually I am using
felix-maven-plugin to do this (which uses bnd under the hood).

altogether having something which works for jetty + equinox is a huge step
forward and a huge help to get the current work in progress from jruby
itself get merged into it.

[viphe]

I achieved to load a Rails app, but had to patch jruby-rack this time. It's got exactly the same problem regarding Jetty + OSGi + ServletContext.getRealPath().

I'm thinking that this issue should be fixed in JRuby::Rack::AppLayout#real_path(): https://github.com/jruby/jruby-rack/blob/d59193e9284bce30a7cae5a8ebb7f4ae8436e110/src/main/ruby/jruby/rack/app_layout.rb#L32-L39

My hack (similar to what I did in Warbler): https://github.com/viphe/jruby-rack/blob/8759fd355cda580fe01bd5cc4606471d3b618b3f/src/main/ruby/jruby/rack/app_layout.rb#L21-L54

It might be that Warbler should leverage jruby-rack's AppLayout#real_path() (or some other method that wraps eventually delegates to it) instead of calling the ServletContext directly.

I am then bumping into the issue of running a Rails app under the context path (I think this is fully supported in Rails 4, but might be more of a challenge in earlier versions). ==> validated that Rails 4 apps are mounted under relative URIs seemlessly.

[viphe]

Some follow up. I ended reimplementing in Ruby the part of FileLocator that I needed (determining the real path to exploded contents of the OSGi bundle. So, it is indeed possible not to depend on org.eclipse.equinox.common.

These changes can be observed here: https://github.com/partnerpedia/warbler/commit/e75c47deee594fcae21641dfd96aff4dc20de99b