It’s about time to pack Ruby and Ruby scripts in one binary

Transcript

1. It’s about time to pack Ruby and Ruby scripts in one binary RubyKaigi 2024 ahogappa
2. About me • Sho Hirano(@ahogappa) • STORES, Inc. • #FFF613 2
3. What’s one binary? 3
4. What’s one binary? Works perfectly with just one file 4
5. Why one binary? 5
6. Why one binary in Ruby? 6
7. Why one binary in Ruby? e.g. distributing a Ruby project 7
8. Why one binary in Ruby? 💻 💻 developer user 8
9. Why one binary in Ruby? 💻 a.rb a.rb a.rb a.rb 💻 developer user 9
10. Why one binary in Ruby? 💻 a.rb a.rb a.rb a.rb 💻 Ruby 3.3.0 Sinatra 4.0.0 Sqlite3 2.0.1 developer user 10
11. Why one binary in Ruby? 💻 a.rb a.rb a.rb a.rb 💻🚫 Ruby 3.3.0 Sinatra 4.0.0 Sqlite3 2.0.1 Ruby 3.0.0 Sinatra 3.2.0 Sqlite3 Not installed developer user 11
12. Why one binary in Ruby? 💻 💻 Ruby 3.3.0 Sinatra 4.0.0 Sqlite3 2.0.1 developer user 12 Ruby 3.0.0 Sinatra 3.2.0 Sqlite3 Not installed
13. Why one binary in Ruby? 💻 💻 one binary developer user Ruby 3.3.0 Sinatra 4.0.0 Sqlite3 2.0.1 13 Ruby 3.0.0 Sinatra 3.2.0 Sqlite3 Not installed
14. Why one binary in Ruby? 💻 💻✔ one binary Ruby 3.3.1 Sinatra 4.0.0 Sqlite3 2.0.1 a.rb a.rb a.rb a.rb developer user Ruby 3.3.1 Sinatra 4.0.0 Sqlite3 2.0.1 14 Ruby 3.0.0 Sinatra 3.2.0 Sqlite3 Not installed
15. Any existing tools? 15
16. Any existing tools? • ocra(ocran) • exerb • ruby2exe • ruby-packer 16
17. 🤔 Existing tools look good and useful 17
18. Existing tools look good and useful, but • No support for 3.0+ • Patches Ruby • Windows only • Write temporary files 18
19. Time to make new one! 😄 19
20. Done 🔧 20
21. Kompo 📦 21
22. Kompo • 梱包(こんぽう) ◦ Means packaging, packing • A word play on “compo” ◦ compose ◦ component ◦ composite ◦ etc… 22 https://github.com/ahogappa0613/kompo
23. Demo One binary with Sinatra and Sqlite3 23
24. Features 24
25. Features • Monkey patch only, not patching Ruby • No write temporary files • Supports Gemfile • Reads local file as a fallback when failing to read from vfs 25
26. Demo Reads local file as a fallback when failing to read from vfs 26
27. How kompo works 27
28. How kompo works • Ruby scripts are embedded • Patch methods that read Ruby scripts ◦ Kernel#require ◦ Kernel#require_relative ◦ Kernel#load ◦ Kernel#autoload, Module#autoload • Native extensions are statically linked 28
29. 29 libruby-static.a
30. 30 libruby-static.a native extensions
31. main.c 31 libruby-static.a native extensions void Init_gems(void) { ruby_init_ext( "puma/puma_http11.so", Init_puma_http11 ); ruby_init_ext( "sqlite3/sqlite3_native.so", Init_sqlite3_native ); } int main(int argc, char **argv) { ruby_sysinit(&argc, &argv); ruby_init(); Init_gems(); Init_kompo_fs(); … return ruby_run_node(node); }
32. main.c 32 kompofs.o +patches libruby-static.a native extensions
33. 33 class Kompo def get_file(abs_path) # return the ruby script from kompofs(.o) end … end main.c libruby-static.a native extensions kompofs.o +patches libkompo.a
34. main.c libkompo.a 34 libruby-static.a kompofs.o +patches native extensions one binary compile and link libruby-static.a
35. Patches 35
36. Patches libruby-static.a main.rb b.rb d.rb a.rb Kernel#require Kernel#require_relative c.so 36
37. Patches libruby-static.a main.rb b.rb d.rb a.rb Kernel#require Kernel#require_relative c.so $ cd /workspace/sample $ kompo a.rb b.rb 37
38. Patches libruby-static.a main.rb b.rb Kernel#require Kernel#require_relative d.rb a.rb c.so 38 kompofs.o
39. Patches Ruby main.rb b.rb Kernel#require Kernel#require_relative c.o d.rb a.rb one binary libkompo.a 39 main.c kompofs.o
40. Patches Ruby main.rb b.rb 🪡Kernel#require 🪡Kernel#require_relative c.o d.rb a.rb one binary libkompo.a 40 module Kernel def require(path) eval(Kompo.get_file(path)) rescue => LoadError original_require(path) main.c kompofs.o
41. Patches Ruby main.rb b.rb 🪡Kernel#require 🪡Kernel#require_relative c.o d.rb a.rb one binary require ‘a’ require_relative ‘./b’ require ‘c’ require ‘d’ libkompo.a 41 module Kernel def require(path) eval(Kompo.get_file(path)) rescue => LoadError original_require(path) main.c kompofs.o
42. Patches Ruby main.rb b.rb 🪡Kernel#require 🪡Kernel#require_relative c.o d.rb a.rb one binary libkompo.a 42 module Kernel def require(path) eval(Kompo.get_file(path)) rescue => LoadError original_require(path) kompofs.o require ‘a’ require_relative ‘./b’ require ‘c’ require ‘d’ main.c
43. Future Works 43
44. Future Works • Support ways for users to access kompofs freely • Cross-compilation • File compression 44
45. Let’s kompo Ruby! 45
46. Thank you!! 46