wasmify-rails 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1fa2c7f453042f39b655707ff49c7ee8d79f3ec381d9627221fa3937d9ac1b8
-  data.tar.gz: 1c18b79d5c1932f812bc1dcc93ab5c642614ef2bf484d9b11a3e0e2fedea851b
+  metadata.gz: 683d693ae789d6a5681cbab9e6f66f8a8fbd52a23d4dc440ff78d14e13c3085d
+  data.tar.gz: e8c18abb0382cbec70d562debbf4f16d82eeece71c9dcdb0a82f916216c3f7a5
 SHA512:
-  metadata.gz: 9f44be4213456165fe64810bb81b97e08eaea66a1af60970065c0e7ddb4ba790082062d9cd43d773c60422cd5c18f97044c940504eab8f2c62e4fab1c6bf1dc7
-  data.tar.gz: e2fb22c5c0466e33a2245ea5dc6ed09c4f68e60cfe58a26ba010fb21b9f499614067bb6ff27eca909a257960c32e04dcbfaad47df7543c3b5130e8a94617d54a
+  metadata.gz: d7aafd09c3e716080f96efa987aeb1825ab5307be9cc1dae32e657f30a4f40314fd65e4ec610b8f271c40b3cd7ad0c951eff9be5cc9e3cd80456edaedec19a6c
+  data.tar.gz: 44619a0600d773ecd96e9f012b0245d6567e5d140b04397577560665ae5b49a9f7983755431f644274ebdb6dc76a3e33c91bf37eee5da56d8e4bfdc8f70a9e9b

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## master
 
+## 0.1.3
+
+- Check if `cookieStore` is available and only manipulate cookies if it is.
+
+- Add `skipWaiting()` to the server worker to force the new version to take over.
+
+## 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.

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.
 
@@ -151,6 +151,29 @@ 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:
+
+- `Kernel#on_wasm?`: a convenient predicate method to check if the code is running in the Wasm environment.
+
+- 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))
@@ -164,7 +187,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_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

@@ -15,6 +15,8 @@ const initDB = async (progress) => {
   progress?.updateStep("Initializing SQLite database...");
   db = await setupSQLiteDatabase();
   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 = () => {
@@ -67,7 +71,7 @@ self.addEventListener("activate", (event) => {
 
 self.addEventListener("install", (event) => {
   console.log("[rails-web] Install Service Worker");
-  event.waitUntil(installApp());
+  event.waitUntil(installApp().then(() => self.skipWaiting()));
 });
 
 const rackHandler = new RackHandler(initVM, { assumeSSL: true });

data/lib/rack/data_uri_uploads.rb

@@ -29,6 +29,7 @@ module Rack
     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)

data/lib/wasmify/rails/version.rb

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

metadata

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