wasmify-rails 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 442a1c699d7e906546d63b1d5c6c451652d65ecd651bd16fa72d98841a845acf
-  data.tar.gz: d8dac2abf684945cc8c9fbd10d3ed6c6236c9535c3f7c3974501638b7be6f607
+  metadata.gz: 67904120ba3d147d07ad14d5e15c6f9faf06eb43f3c93d132326407581be4ad7
+  data.tar.gz: c88da10a277060fcda66faa34f1334dc246870d4ab0d32655772d0b05ed534a2
 SHA512:
-  metadata.gz: 14b9d7c161e577b80d5d9b92d6cb6a7294203f535f938423b194e4adf204541f0d93c4efa466847d2546bf8a919aa96c82037613fb31c7114f3fe1c4debaa5ee
-  data.tar.gz: 61c8ee0c9f26376f53e22bff246bba40c9d038094d846c17cc7b022f600344c70142777901d28d60eb41a5c8471c4dacbf6c188166a0aa76e1b88554c52900e9
+  metadata.gz: 78a1328a1ee3339968a6715b1482012f77dff692b69a55062a7c0eb1c460a7c631c617149a863eac7771c5dcccbd3673fa4fb18ca916005e215615db50bea210
+  data.tar.gz: f128859e3c1f7e5ab2eee405afe71e7a5bd9fd593cfe88dae69cf6dd91f70b837c2bfe42364b95da2a1d60507776e28123dc7389a48231f720a5b9acbd599f80

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 ## master
 
+## 0.1.2
+
+- Add cache support to Rack handler.
+
+  Now we use `caches` for files with `Cache-Control`, so we don't perform a Wasm request.
+
+- Minor fixes and improvements.
+
+## 0.1.1
+
+- Support multipart file uploads by converting files to data URIs.
+
+  At the Rack side, we use a `Rack::DataUriUploads` middleware to automatically convert
+  data-URI-encoded files to files uploads, so the application can handle them as usual.
+
 ## 0.1.0
 
 - Initial release

data/README.md

@@ -13,7 +13,7 @@ Adding to your Gemfile:
 gem "wasmify-rails", group: [:development, :wasm]
 ```
 
-## Usage
+## Usage: generators and tasks
 
 This gem comes with a few commands (Rake tasks) to help you get started with packing your Rails app into a Wasm module.
 
@@ -147,11 +147,35 @@ bin/rails wasmify:pack
 
 And go to the `pwa` for the instructions on how to launch the application.
 
+Here is an example app:
+
+<video src="https://github.com/user-attachments/assets/34e54379-5f3e-42eb-a4fa-96c9aaa91869"></video>
+
+## Rails/Ruby extensions
+
+This gem provides a variety of _adapters_ and plugins to make your Rails application Wasm-compatible:
+
+- Active Record
+
+  - `sqlite3_wasm` adapter: work with `sqlite3` Wasm just like with a regular SQLite database.
+  - `nulldb` adapter for testing purposes.
+
+- Active Storage
+
+  - `null` variant processor (just leaves files as is)
+
+- Action Mailer
+
+  - `null` delivery method (to disable emails in Wasm)
+
+- Rack
+
+  - `Rack::DataUriUploads` middleware to transparently transform Data URI uploads into files.
+
 ## Roadmap
 
 - PGLite support (see [this example](https://github.com/kateinoigakukun/mastodon/blob/fff2e4a626a20a616c546ddf4f91766abaf1133a/pwa/dist/pglite.rb#L1))
 - Active Storage OPFS service
-- File uploads support (multipart/form-data)
 - Background jobs support
 - WASI Preview 2 support (also [this](https://github.com/kateinoigakukun/mastodon/tree/katei/wasmify))
 
@@ -161,7 +185,7 @@ Bug reports and pull requests are welcome on GitHub at [https://github.com/](htt
 
 ## Credits
 
-The `nulldb` adapter for Active Record (used for tests) is adopted from [this project](https://github.com/nulldb/nulldb).
+The `nulldb` adapter for Active Record (used for tests) is ported from [this project](https://github.com/nulldb/nulldb).
 
 ## License
 

data/lib/{active_storage → action_mailer}/null_delivery.rb

@@ -11,5 +11,5 @@ module ActionMailer
 end
 
 ActiveSupport.on_load(:action_mailer) do
-  ActionMailer::Base.add_delivery_method :null
+  ActionMailer::Base.add_delivery_method :null, ActionMailer::NullDeliveryMethod
 end

data/lib/active_record/connection_adapters/sqlite3_wasm_adapter.rb

@@ -118,6 +118,7 @@ module ActiveRecord
               str_val = val.to_s
               next str_val if val.typeof == "string"
               next str_val == "true" if val.typeof == "boolean"
+              next nil if str_val == "null"
 
               # handle integers and floats
               next str_val.include?(".") ? val.to_f : val.to_i if val.typeof == "number"
@@ -136,14 +137,37 @@ module ActiveRecord
         end
       end
 
+      # This type converts byte arrays represented as strings from JS to binaries in Ruby
+      class JSBinary < ActiveModel::Type::Binary
+        def deserialize(value)
+          bvalue = value
+          if value.is_a?(String)
+            bvalue = value.split(",").map(&:to_i).pack("c*")
+          end
+
+          super(bvalue)
+        end
+      end
+
+      ActiveRecord::Type.register(:binary, JSBinary, adapter: :sqlite3_wasm)
+
       class << self
         def database_exists?(config)
           true
         end
 
         def new_client(config) = ExternalInterface.new(config)
+
+        private
+          def initialize_type_map(m)
+            super
+            register_class_with_limit m, %r(binary)i, JSBinary
+          end
       end
 
+      # Re-initialize type map to include JSBinary
+      TYPE_MAP = Type::TypeMap.new.tap { |m| initialize_type_map(m) }
+
       attr_reader :external_interface
 
       def initialize(...)

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

@@ -47,10 +47,15 @@ class Wasmify::InstallGenerator < Rails::Generators::Base
     end
   end
 
-  def skip_bundler_setup_in_boot
+  def configure_boot_file
     inject_into_file "config/boot.rb", after: /require ['"]bundler\/setup['"]/ do
       " unless RUBY_PLATFORM =~ /wasm/"
     end
+
+    # Disable bootsnap if any
+    inject_into_file "config/boot.rb", after: /require ['"]bootsnap\/setup['"]/ do
+      " unless RUBY_PLATFORM =~ /wasm/"
+    end
   end
 
   def add_tzinfo_data_to_gemfile

data/lib/generators/wasmify/install/templates/config/environments/wasm.rb

@@ -26,5 +26,8 @@ Rails.application.configure do
     config.active_storage.variant_processor = :null
   end
 
-  config.secret_key_base = "<change-me>"
+  # Do not use the same secret key base in a local app (for security reasons)
+  config.secret_key_base = "wasm-secret"
+  # Use a different session cookie name to avoid conflicts
+  config.session_store :cookie_store, key: "_local_session"
 end

data/lib/generators/wasmify/install/templates/config/wasmify.yml

@@ -15,3 +15,4 @@ exclude_gems:
   - nio4r
   - io-console
   - psych
+  - date

data/lib/generators/wasmify/pwa/templates/pwa/database.js

@@ -4,15 +4,7 @@ export const setupSQLiteDatabase = async () => {
   const sqlite3 = await sqlite3InitModule();
 
   console.log("Running SQLite3 version", sqlite3.version.libVersion);
-  const db =
-    "opfs" in sqlite3
-      ? new sqlite3.oo1.OpfsDb("/railsdb.sqlite3")
-      : new sqlite3.oo1.DB("/railsdb.sqlite3", "ct");
-  console.log(
-    "opfs" in sqlite3
-      ? `OPFS is available, created persisted database at ${db.filename}`
-      : `OPFS is not available, created transient database ${db.filename}`,
-  );
-
+  // NOTE: This database is transient and will be lost if you uninstall the service worker (aka hard reset)
+  const db = new sqlite3.oo1.DB("/railsdb.sqlite3", "ct");
   return db;
 };

data/lib/generators/wasmify/pwa/templates/pwa/rails.sw.js

@@ -12,9 +12,11 @@ let db = null;
 const initDB = async (progress) => {
   if (db) return db;
 
-  progress.updateStep("Initializing SQLite database...");
+  progress?.updateStep("Initializing SQLite database...");
   db = await setupSQLiteDatabase();
-  progress.updateStep("SQLite database created.");
+  progress?.updateStep("SQLite database created.");
+
+  return db;
 };
 
 let vm = null;
@@ -47,6 +49,8 @@ const initVM = async (progress, opts = {}) => {
   vm.eval("ActiveRecord::Tasks::DatabaseTasks.prepare_all");
 
   redirectConsole = false;
+
+  return vm;
 };
 
 const resetVM = () => {

data/lib/image_processing/null.rb

@@ -14,6 +14,7 @@ module ImageProcessing
         fail ArgumentError, "File not found: #{source}" unless File.file?(source)
 
         if destination
+          File.delete(destination) if File.identical?(source, destination)
           FileUtils.cp(source, destination)
         end
       end

data/lib/rack/data_uri_uploads.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "rack"
+require "base64"
+
+module Rack
+  class DataUriUploads
+    # A specific prefix we use to identify data URIs that must be transformed
+    # into file uploads.
+    PREFIX = "BbC14y"
+    DATAURI_REGEX = %r{^#{PREFIX}data:(.*?);(.*?),(.*)$}
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      return @app.call(env) unless env[RACK_INPUT]
+
+      request = Rack::Request.new(env)
+
+      if request.post? || request.put? || request.patch?
+        transform_params(request.params)
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def transform_params(params)
+      return params unless params.is_a?(Hash)
+      params.each do |key, value|
+        if value.is_a?(String) && value.match?(DATAURI_REGEX)
+          params[key] = from_data_uri(value)
+        elsif value.is_a?(Hash)
+          transform_params(value)
+        elsif value.is_a?(Array)
+          value.each { transform_params(_1) }
+        end
+      end
+    end
+
+    def from_data_uri(data_uri)
+      matches = data_uri.match(DATAURI_REGEX)
+
+      content_type = matches[1]
+      encoding = matches[2]
+      data = matches[3]
+
+      file_data = Base64.decode64(data)
+
+      file = Tempfile.new(["upload", mime_to_extension(content_type)])
+      file.binmode
+      file.write(file_data)
+      file.rewind
+
+      # Create a Rack::Test::UploadedFile, so it works with strong parameters
+      Rack::Test::UploadedFile.new(file.path, content_type)
+    end
+
+    def mime_to_extension(mime_type)
+      mime_type.split("/").then do |parts|
+        next "" unless parts.length == 2
+        ".#{parts.last}"
+      end
+    end
+  end
+end

data/lib/wasmify/rails/railtie.rb

@@ -6,6 +6,12 @@ module Wasmify
       rake_tasks do
         load "wasmify/rails/tasks.rake"
       end
+
+      initializer "wasmify.rack_data_uri" do |app|
+        require "rack/data_uri_uploads"
+
+        app.middleware.use Rack::DataUriUploads
+      end
     end
   end
 end

data/lib/wasmify/rails/version.rb

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

data/lib/wasmify-rails.rb

@@ -18,6 +18,8 @@ module ImageProcessing
   autoload :Null, "image_processing/null"
 end
 
+require "action_mailer/null_delivery"
+
 # NullDB for Active Record
 ActiveRecord::ConnectionAdapters.register("nulldb", "ActiveRecord::ConnectionAdapters::NullDBAdapter", "active_record/connection_adapters/nulldb_adapter")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wasmify-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-21 00:00:00.000000000 Z
+date: 2024-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -122,6 +122,7 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- lib/action_mailer/null_delivery.rb
 - lib/active_record/connection_adapters/nulldb_adapter.rb
 - lib/active_record/connection_adapters/nulldb_adapter/checkpoint.rb
 - lib/active_record/connection_adapters/nulldb_adapter/column.rb
@@ -134,7 +135,6 @@ files:
 - lib/active_record/connection_adapters/nulldb_adapter/statement.rb
 - lib/active_record/connection_adapters/nulldb_adapter/table_definition.rb
 - lib/active_record/connection_adapters/sqlite3_wasm_adapter.rb
-- lib/active_storage/null_delivery.rb
 - lib/generators/wasmify/install/USAGE
 - lib/generators/wasmify/install/install_generator.rb
 - lib/generators/wasmify/install/templates/config/environments/wasm.rb
@@ -150,6 +150,7 @@ files:
 - lib/generators/wasmify/pwa/templates/pwa/rails.sw.js
 - lib/generators/wasmify/pwa/templates/pwa/vite.config.js
 - lib/image_processing/null.rb
+- lib/rack/data_uri_uploads.rb
 - lib/wasmify-rails.rb
 - lib/wasmify/rails/builder.rb
 - lib/wasmify/rails/configuration.rb
@@ -178,7 +179,7 @@ metadata:
   documentation_uri: https://github.com/palkan/wasmify-rails
   homepage_uri: https://github.com/palkan/wasmify-rails
   source_code_uri: https://github.com/palkan/wasmify-rails
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -193,8 +194,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.5.16
+signing_key: 
 specification_version: 4
 summary: Tools and extensions to package Rails apps as Wasm modules
 test_files: []