wasmify-rails 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 683d693ae789d6a5681cbab9e6f66f8a8fbd52a23d4dc440ff78d14e13c3085d
-  data.tar.gz: e8c18abb0382cbec70d562debbf4f16d82eeece71c9dcdb0a82f916216c3f7a5
+  metadata.gz: 0ec3282837b68355a92061618b21324e72476610f34c9a99538f7af28461836e
+  data.tar.gz: 195c3113bfa6d07d8e8f589739e415bbeff0518d5fb3248b8450c997c084fd4e
 SHA512:
-  metadata.gz: d7aafd09c3e716080f96efa987aeb1825ab5307be9cc1dae32e657f30a4f40314fd65e4ec610b8f271c40b3cd7ad0c951eff9be5cc9e3cd80456edaedec19a6c
-  data.tar.gz: 44619a0600d773ecd96e9f012b0245d6567e5d140b04397577560665ae5b49a9f7983755431f644274ebdb6dc76a3e33c91bf37eee5da56d8e4bfdc8f70a9e9b
+  metadata.gz: 3429caf51620abc60aa2de1ec5b0a81743e15cf95bfc2c39081c48e764e738ae7ec78a6bc8e3b44e0b213238593abf774dbd5a2260217d820e887f663d75c26e
+  data.tar.gz: 47907d81582be81de0e2ac6225d70356ca2157a42e627af19dde13dbbe2e59105736c953ac8e7d45acd49f1442423398256adb3a140c15a64f498c53134fad45

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## master
 
+## 0.1.5
+
+- Added async mode to rack.js.
+
+- Added ability to pass env vars to Ruby VM.
+
+- Rails 8 support for `sqlite3_wasm` adapter.
+
+## 0.1.4
+
+- Improve `wasmify:install`.
+
+  Make it work with the `rails new` app without any manual steps.
+
 ## 0.1.3
 
 - Check if `cookieStore` is available and only manipulate cookies if it is.

data/README.md

@@ -4,6 +4,9 @@
 
 This gem provides tools and extensions to compile Rails applications to WebAssembly.
 
+> [!NOTE]
+> Read more in our handbook: [Rails on Wasm](https://writebook-on-wasm.fly.dev/5/ruby-on-rails-on-webassembly)
+
 ## Installation
 
 Adding to your Gemfile:
@@ -31,6 +34,8 @@ The script will tweak you configuration files and create a couple of new ones:
 
 - `config/wasmify.yml` — this is a configuration file for different _wasmify_ commands (see below).
 
+It also adds the `wasm` group to your Gemfile (see below on that).
+
 ### Step 2: `bin/rails wasmify:build:core`
 
 Now, it's time to build a ruby.wasm with all your project dependencies (from the Gemfile). This is gonna be a base Wasm module
@@ -57,7 +62,9 @@ end
 ...
 ```
 
-**NOTE:** If you use `ruby file: ".ruby-version"` in your Gemfile, you should probably configure the Ruby version for Wasm platform
+We try to mark gems as wasm-compatible during the `wasmify:install` phase, but it's likely that you will need to adjust the Gemfile manually.
+
+If you use `ruby file: ".ruby-version"` in your Gemfile, you should probably configure the Ruby version for Wasm platform
 a bit differently (since patch versions might not match). For example:
 
 ```ruby
@@ -68,6 +75,12 @@ else
 end
 ```
 
+Or just disable the Ruby version check for the Wasm platform:
+
+```ruby
+ruby file: ".ruby-version" unless RUBY_PLATFORM =~ /wasm/
+```
+
 Now, try to run the following command:
 
 ```sh

data/lib/active_record/connection_adapters/sqlite3_wasm_adapter.rb

@@ -1,3 +1,14 @@
+# Rails 8 compatibility
+module SQLite3
+  module ForkSafety
+    def self.suppress_warnings!
+    end
+  end
+
+  class BusyException < StandardError
+  end
+end
+
 require "active_record/connection_adapters/sqlite3_adapter"
 
 module SQLite3
@@ -33,6 +44,12 @@ module ActiveRecord
           JS.global[js_interface].exec(...)
         end
 
+        def execute_batch2(...)
+          # TODO: it's used by fixtures and truncate_all, so
+          # we don't need it right now
+          raise NotImplementedError, "sqlite3_wasm#execute_batch2 is not implemented yet"
+        end
+
         def busy_timeout(...) = nil
 
         def execute(sql)
@@ -106,6 +123,8 @@ module ActiveRecord
           @rows
         end
 
+        def column_count = columns.size
+
         def execute
           return if @rows
 
@@ -182,6 +201,29 @@ module ActiveRecord
       def database_exists? = true
 
       def database_version = SQLite3Adapter::Version.new("3.45.1")
+
+      # Rails 8 interface
+      def perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch: false)
+        if batch
+          raw_connection.execute_batch2(sql)
+        elsif prepare
+          raise NotImplementedError, "sqlite3_wasm prepared statements are not implemented yet"
+        else
+          stmt = raw_connection.prepare(sql)
+          result =
+            if stmt.column_count.zero?
+              ActiveRecord::Result.empty
+            else
+              ActiveRecord::Result.new(stmt.columns, stmt.to_a)
+            end
+        end
+
+        @last_affected_rows = raw_connection.changes
+        verified!
+
+        notification_payload[:row_count] = result&.length || 0
+        result
+      end
     end
   end
 end

data/lib/generators/wasmify/install/install_generator.rb

@@ -54,25 +54,87 @@ class Wasmify::InstallGenerator < Rails::Generators::Base
 
     # Disable bootsnap if any
     inject_into_file "config/boot.rb", after: /require ['"]bootsnap\/setup['"]/ do
+      %q( unless ENV["RAILS_ENV"] == "wasm")
+    end
+  end
+
+  def disable_ruby_version_check_in_gemfile
+    inject_into_file "Gemfile", after: /^ruby[^#\n]+/ do
       " unless RUBY_PLATFORM =~ /wasm/"
     end
   end
 
   def add_tzinfo_data_to_gemfile
+    # First, comment out the existing tzinfo-data gem declaration
+    comment_lines "Gemfile", /^gem ['"]tzinfo-data['"]/
+
     append_to_file "Gemfile", <<~RUBY
 
       group :wasm do
         gem "tzinfo-data"
       end
     RUBY
+  end
 
-    run "bundle install"
+  KNOWN_NO_WASM_GEMS = %w[
+    bootsnap
+    puma
+    sqlite3
+    activerecord-enhancedsqlite3-adapter
+    pg
+    mysql2
+    redis
+    solid_cable
+    solid_queue
+    solid_cache
+    jsbundling-rails
+    cssbundling-rails
+    thruster
+    kamal
+    byebug
+    web-console
+    listen
+    spring
+    debug
+  ].freeze
+
+  def add_wasm_group_to_gemfile
+    # This is a very straightforward implementation:
+    # - scan the Gemfile for _root_ dependencies (not within groups)
+    # - add `group: [:default, :wasm]` to those not from the exclude list
+
+    top_gems = []
+
+    File.read("Gemfile").then do |gemfile|
+      gemfile.scan(/^gem ['"]([^'"]+)['"](.*)$/).each do |match|
+        gem_name = match.first
+        top_gems << gem_name unless match.last&.include?(":wasm")
+      end
+    end
+
+    gems_to_include = top_gems - KNOWN_NO_WASM_GEMS
+
+    return if gems_to_include.empty?
+
+    regexp = /^gem ['"](?:#{gems_to_include.join("|")})['"][^#\n]*/
+
+    gsub_file "Gemfile", regexp do |match|
+      match << ", group: [:default, :wasm]"
+    end
+  end
+
+  def fix_solid_queeue_production_config
+    inject_into_file "config/environments/production.rb", after: %r{config.solid_queue.connects_to = [^#\n]+} do
+      " if config.respond_to?(:solid_queue)"
+    end
   end
 
   def finish
+    run "bundle install"
+
     say_status :info, "✅ The application is prepared for Wasm-ificaiton!\n\n" \
                       "Next steps are:\n" \
-                      " - Gemfile: Add `group: [:default, :wasm]` to the dependencies required in Wasm runtime" \
+                      " - Check your Gemfile: add `group: [:default, :wasm]` to the dependencies required in Wasm runtime" \
                       " - Run `bin/rails wasmify:build:core:verify` to see if the bundle compiles"
   end
 end

data/lib/generators/wasmify/pwa/templates/pwa/package.json.tt

@@ -10,7 +10,7 @@
     "preview": "vite preview"
   },
   "devDependencies": {
-    "vite": "^5.4.7",
+    "vite": "^4.4.5",
     "vite-plugin-pwa": "^0.20.5"
   },
   "dependencies": {

data/lib/wasmify/rails/configuration.rb

@@ -2,6 +2,11 @@
 
 module Wasmify
   module Rails
+    RUBY_VERSION_TO_WASM_RUBY_VERSION = {
+      "3.3" => "3.3.3",
+      "3.2" => "3.2.4"
+    }
+
     class Configuration
       attr_reader :pack_directories, :exclude_gems, :ruby_version,
                   :tmp_dir, :output_dir,
@@ -29,12 +34,16 @@ module Wasmify
         end
       end
 
+      def ruby_version = @ruby_version ||= ruby_version_from_file || "3.3"
+
       private
 
       def ruby_version_from_file
         return unless File.file?(::Rails.root.join(".ruby-version"))
 
-        File.read(::Rails.root.join(".ruby-version")).strip
+        File.read(::Rails.root.join(".ruby-version")).strip.match(/(\d+\.\d+(?:\.d+)?)/).then do |matches|
+          matches[1] if matches
+        end
       end
     end
   end

data/lib/wasmify/rails/tasks.rake

@@ -14,7 +14,7 @@ namespace :wasmify do
   desc "Build ruby.wasm with all dependencies"
   task :build do
     unless ENV["BUNDLE_ONLY"] == "wasm"
-      next spawn("BUNDLE_ONLY=wasm bundle exec rails wasmify:build").then { Process.wait(_1) }
+      next spawn("RAILS_ENV=wasm BUNDLE_ONLY=wasm bundle exec rails wasmify:build").then { Process.wait(_1) }
     end
 
     require "wasmify/rails/builder"
@@ -27,7 +27,7 @@ namespace :wasmify do
     desc "Build ruby.wasm with all dependencies but JS shim (to use with wasmtime)"
     task :core do
       unless ENV["BUNDLE_ONLY"] == "wasm"
-        next spawn("BUNDLE_ONLY=wasm bundle exec rails wasmify:build:core").then { Process.wait(_1) }
+        next spawn("RAILS_ENV=wasm BUNDLE_ONLY=wasm bundle exec rails wasmify:build:core").then { Process.wait(_1) }
       end
 
       require "wasmify/rails/builder"

data/lib/wasmify/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Wasmify
   module Rails # :nodoc:
-    VERSION = "0.1.3"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wasmify-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties