RubyGems - isorun - Versions diffs - 0.1.7-x86_64-darwin → 0.1.8-x86_64-darwin - Mend

isorun 0.1.7-x86_64-darwin → 0.1.8-x86_64-darwin

Files changed (17) hide show

checksums.yaml +4 -4
data/Rakefile +2 -2
data/app/helpers/isorun/app_helper.rb +20 -6
data/ext/isorun/Cargo.toml +10 -10
data/ext/isorun/src/isorun/context.rs +13 -7
data/ext/isorun/src/isorun/function.rs +5 -5
data/ext/isorun/src/isorun/module.rs +5 -4
data/ext/isorun/src/isorun/utils.rs +66 -0
data/ext/isorun/src/js/worker.rs +1 -0
data/ext/isorun/src/lib.rs +11 -0
data/lib/isorun/2.7/isorun.bundle +0 -0
data/lib/isorun/3.0/isorun.bundle +0 -0
data/lib/isorun/3.1/isorun.bundle +0 -0
data/lib/isorun/context.rb +49 -5
data/lib/isorun/engine.rb +0 -1
data/lib/isorun/version.rb +1 -1
metadata +51 -6

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a94fe4b9a33a91a13ec9c0f6a266f639a5f801529ae1dae8d85d3ea42b1df0
-  data.tar.gz: af2ac08336a9e5bc8fe54fe73d3ea692b84a01e02d98924f2043106c221affcc
+  metadata.gz: a611e71b2fb8ba1f62c3eb3ba1d62914e4cad152a0c404d308ead15fbcf5ed8b
+  data.tar.gz: 6a0c9b323c9e9676ddd1215e2f8299f1cee3cbd70c31e73598bd497cd8ee6e2d
 SHA512:
-  metadata.gz: d459628aab2cb4a0e2940fc71b8e570578bbc19c21292668de88342887793332ef646056fc0b2086d6a34a0c83d45503eb283eefffe02014f695082af16740ea
-  data.tar.gz: 76427407e9083bd6c50e9a9f952e49158dc8e7dc64701e59ab3040fd807969015e0c79ec5bda153b31493e7fd5af840283795cf36b62d51f9d27a2fda83a7e1c
+  metadata.gz: c8556803ee6aa905c1e713fd4940143cf96c220dce608c5d46f975172f0b035bac4916bcfb99d5c68c5bd77724dc5928cecd94b78ac58d1c258d445421d42ab5
+  data.tar.gz: da661918f416b7892131f4fa0f1cc16dd710d57d3c661441bd898680e4726c45c68bcb4165e656494440663af4fc8895b3cb0b3c8704c2a765f1d05437a466dd

data/Rakefile CHANGED Viewed

@@ -6,7 +6,7 @@ require "rake/testtask"
 require "rake/extensiontask"
 require "rb_sys"
-cross_rubies = %w[3.1.0 3.0.0 2.7.0]
+cross_rubies = %w[3.2.0 3.1.0 3.0.0 2.7.0]
 cross_platforms = %w[
   arm64-darwin
   x86_64-darwin
@@ -72,7 +72,7 @@ begin
   YARD::Rake::YardocTask.new
-  task docs: :environment do
+  task :docs do
     `yard server --reload`
   end
 rescue LoadError

data/app/helpers/isorun/app_helper.rb CHANGED Viewed

@@ -2,10 +2,27 @@
 module Isorun
   module AppHelper
+    # The isorun_app helper is the most convenient way to server-side render
+    # a JavaScript application, including state extraction and automatic
+    # rehydration. The helper tries to render the application and will also
+    # inject the client-side code immediately after the rendered result.
+    #
+    # @example Renders a JavaScript application
+    #   <html>
+    #   <body>
+    #     <%= isorun_app("my_app") %>
+    #   </body>
+    #   </html>
+    #
+    # @param id [String] An ID representing both, the asset bundle, and by
+    #   convention, the target node (e.g. `<div id="my_app">`)
+    # @return [String]
     def isorun_app(id) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      ActiveSupport::Notifications.instrument "start.render.isorun", { ts: Time.current }
       module_path = Isorun.config.module_resolver.call(id)
-      ssr_html = Isorun::Context.create do |context|
+      ssr_html = Isorun::Context.create(receiver: Isorun.config.receiver) do |context|
         render_context = { environment: Rails.env.to_s }
         render_function = context.import.from(module_path)
@@ -17,13 +34,10 @@ module Isorun
           return ""
         end
-        # set receiver to allow calling into Ruby from JavaScript
-        context.receiver = Isorun.config.receiver
         html = render_function.call(render_context)
-        # reset receiver
-        context.receiver = nil
+        ActiveSupport::Notifications.instrument "finish.render.isorun", { ts: Time.current }
+        ActiveSupport::Notifications.instrument "stats.isorun", Isorun.stats
         html
       end

data/ext/isorun/Cargo.toml CHANGED Viewed

@@ -1,26 +1,26 @@
 [package]
 name = "isorun"
-version = "0.1.7"
+version = "0.1.8"
 edition = "2021"
 authors = ["Hannes Moser <box@hannesmoser.at>"]
 homepage = "https://github.com/eliias/isorun"
 repository = "https://github.com/eliias/isorun"
 [dependencies]
-deno_console = "0.82.0"
-deno_core = "0.164.0"
-deno_fetch = "0.106.0"
-deno_runtime = "0.90.0"
-deno_url = "0.82.0"
-deno_web = "0.113.0"
-deno_webidl = "0.82.0"
+deno_console = "0.83.0"
+deno_core = "0.165.0"
+deno_fetch = "0.107.0"
+deno_runtime = "0.91.0"
+deno_url = "0.83.0"
+deno_web = "0.114.0"
+deno_webidl = "0.83.0"
 lazy_static = "1.4.0"
-magnus = { git = "https://github.com/eliias/magnus", rev = "3289eeda7ea63831c0277b153666f1efab3866bb" }
+magnus = { git = "https://github.com/eliias/magnus", rev = "5220756ca0ab4f2bc32d38310c26f7dda2be9bd6" }
 tokio = { version = "1.21.1", features = ["full"] }
 v8 = "0.60.0"
 [dev-dependencies]
-magnus = { git = "https://github.com/eliias/magnus", rev = "3289eeda7ea63831c0277b153666f1efab3866bb", features = ["embed"] }
+magnus = { git = "https://github.com/eliias/magnus", rev = "5220756ca0ab4f2bc32d38310c26f7dda2be9bd6", features = ["embed"] }
 [lib]
 name = "isorun"

data/ext/isorun/src/isorun/context.rs CHANGED Viewed

@@ -3,7 +3,7 @@ use crate::js::module::Module;
 use crate::js::worker::WORKER;
 use deno_core::JsRealm;
 use magnus::block::Proc;
-use magnus::Error;
+use magnus::{exception, Error};
 use std::cell::RefCell;
 use std::rc::Rc;
@@ -19,7 +19,10 @@ impl Context {
             .with(|worker| worker.create_realm())
             .map(|realm| Context(Rc::new(RefCell::from(realm))))
             .map_err(|_error| {
-                Error::runtime_error("cannot create JavaScript context")
+                Error::new(
+                    exception::runtime_error(),
+                    "cannot create JavaScript context",
+                )
             })
     }
@@ -41,11 +44,14 @@ impl Context {
             })
             .map(|module| isorun::Module(RefCell::from(module)))
             .map_err(|error| {
-                Error::runtime_error(format!(
-                    "cannot load module: `{}`: {}",
-                    path.as_str(),
-                    error
-                ))
+                Error::new(
+                    exception::runtime_error(),
+                    format!(
+                        "cannot load module: `{}`: {}",
+                        path.as_str(),
+                        error
+                    ),
+                )
             })
     }
 }

data/ext/isorun/src/isorun/function.rs CHANGED Viewed

@@ -1,6 +1,6 @@
 use crate::js;
 use crate::js::worker::WORKER;
-use magnus::Error;
+use magnus::{exception, Error};
 use std::cell::RefCell;
 use std::ops::Deref;
 use v8::{Global, Value};
@@ -28,10 +28,10 @@ impl Function {
             let result =
                 self.0.borrow().call(v8_args.as_slice()).map_err(|error| {
-                    Error::runtime_error(format!(
-                        "cannot call function: {}",
-                        error
-                    ))
+                    Error::new(
+                        exception::runtime_error(),
+                        format!("cannot call function: {}", error),
+                    )
                 });
             result

data/ext/isorun/src/isorun/module.rs CHANGED Viewed

@@ -1,6 +1,6 @@
 use crate::isorun::function::Function;
 use crate::js;
-use magnus::Error;
+use magnus::{exception, Error};
 use std::cell::RefCell;
 #[magnus::wrap(class = "Isorun::Module")]
@@ -19,9 +19,10 @@ impl Module {
         export_name: String,
     ) -> Result<magnus::Value, Error> {
         let module = self.0.borrow();
-        let module_item = module
-            .import(export_name.as_str())
-            .map_err(|error| Error::runtime_error(format!("{}", error)))?;
+        let module_item =
+            module.import(export_name.as_str()).map_err(|error| {
+                Error::new(exception::runtime_error(), format!("{}", error))
+            })?;
         match module_item {
             js::module_item::ModuleItem::Value(v) => Ok(v.to_ruby().unwrap()),

data/ext/isorun/src/isorun/utils.rs CHANGED Viewed

@@ -1,3 +1,4 @@
+use crate::js::worker::WORKER;
 use deno_core::error::AnyError;
 use magnus::r_hash::ForEach;
 use magnus::value::{Qfalse, Qtrue};
@@ -5,6 +6,7 @@ use magnus::{
     Integer, RArray, RFloat, RHash, RString, RStruct, Symbol, Value, QFALSE,
     QNIL, QTRUE,
 };
+use std::collections::HashMap;
 use v8::{Array, GetPropertyNamesArgs, Global, HandleScope, Local, Object};
 pub fn convert_v8_to_ruby(
@@ -157,3 +159,67 @@ pub fn convert_ruby_to_v8<'s>(
     Ok(v8::null(scope).into())
 }
+pub(crate) fn low_memory_notification() {
+    WORKER.with(|worker| {
+        let mut worker = worker.worker.borrow_mut();
+        worker.js_runtime.v8_isolate().low_memory_notification();
+    });
+}
+pub(crate) fn stats() -> RHash {
+    WORKER.with(|worker| {
+        let mut worker = worker.worker.borrow_mut();
+        let heap_stats = &mut Default::default();
+        worker
+            .js_runtime
+            .v8_isolate()
+            .get_heap_statistics(heap_stats);
+        let current_thread = std::thread::current();
+        let thread = HashMap::from([(
+            "thread_id",
+            format!("{:?}", current_thread.id()),
+        )]);
+        let heap = HashMap::from([
+            ("external_memory", heap_stats.external_memory()),
+            ("heap_size_limit", heap_stats.heap_size_limit()),
+            ("malloced_memory", heap_stats.malloced_memory()),
+            (
+                "number_of_detached_contexts",
+                heap_stats.number_of_detached_contexts(),
+            ),
+            (
+                "number_of_native_contexts",
+                heap_stats.number_of_native_contexts(),
+            ),
+            ("peak_malloced_memory", heap_stats.peak_malloced_memory()),
+            ("total_available_size", heap_stats.total_available_size()),
+            (
+                "total_global_handles_size",
+                heap_stats.total_global_handles_size(),
+            ),
+            ("total_heap_size", heap_stats.total_heap_size()),
+            (
+                "total_heap_size_executable",
+                heap_stats.total_heap_size_executable(),
+            ),
+            ("total_physical_size", heap_stats.total_physical_size()),
+            (
+                "used_global_handles_size",
+                heap_stats.used_global_handles_size(),
+            ),
+            ("used_heap_size", heap_stats.used_heap_size()),
+        ]);
+        let h = RHash::new();
+        h.aset("current_thread", RHash::from_iter(thread))
+            .expect("cannot set stats for current_thread");
+        h.aset("heap", RHash::from_iter(heap))
+            .expect("cannot set stats for heap");
+        h
+    })
+}

data/ext/isorun/src/js/worker.rs CHANGED Viewed

@@ -229,6 +229,7 @@ impl Default for Worker {
                 inspect: false,
             },
             extensions: std::mem::take(&mut extensions),
+            extensions_with_js: Default::default(),
             startup_snapshot: None,
             unsafely_ignore_certificate_errors: None,
             root_cert_store: None,

data/ext/isorun/src/lib.rs CHANGED Viewed

@@ -1,4 +1,6 @@
+use self::isorun::utils::stats;
 use crate::isorun::context::Context;
+use crate::isorun::utils::low_memory_notification;
 use isorun::function::Function;
 use isorun::module::Module;
 use magnus::{define_module, function, method, Error, Module as M, Object};
@@ -10,6 +12,15 @@ mod js;
 fn init() -> Result<(), Error> {
     let root = define_module("Isorun").expect("cannot define module: Isorun");
+    root.define_module_function("stats", function!(stats, 0))
+        .expect("cannot define module function: stats");
+    root.define_module_function(
+        "low_memory_notification",
+        function!(low_memory_notification, 0),
+    )
+    .expect("cannot define module function: low_memory_notification");
     let context = root
         .define_class("Context", Default::default())
         .expect("cannot define class: Isorun::Context");

data/lib/isorun/2.7/isorun.bundle CHANGED Viewed

Binary file

data/lib/isorun/3.0/isorun.bundle CHANGED Viewed

Binary file

data/lib/isorun/3.1/isorun.bundle CHANGED Viewed

Binary file

data/lib/isorun/context.rb CHANGED Viewed

@@ -10,7 +10,10 @@ module Isorun
         @export_names = export_names
       end
+      # Specify the module to import from
       def from(module_path)
+        module_path = module_path.to_s if module_path.is_a? Pathname
         mod = load(module_path)
         imports = export_names.map { |export_name| mod.import(export_name) }
         return imports.first if imports.size == 1
@@ -23,7 +26,7 @@ module Isorun
       CACHE_KEY = "isorun_module_path_mtime"
       private_constant :CACHE_KEY
-      def load(module_path)
+      def load(module_path) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         return context.load(module_path) if Rails.env.production?
         key = module_path.parameterize
@@ -41,10 +44,14 @@ module Isorun
         # map to URI scheme to allow adding a timestamp to bust module cache
         module_path = "file://#{module_path}?t=#{mtime}"
-        return context.load(module_path) if cache_miss
+        if cache_miss
+          ActiveSupport::Notifications.instrument "load.module.isorun", { path: module_path }
+          return context.load(module_path)
+        end
         Rails.cache.write("#{CACHE_KEY}:#{key}", mtime) if prev_mtime < mtime
+        ActiveSupport::Notifications.instrument "load.module.isorun", { path: module_path }
         context.load(module_path)
       end
     end
@@ -52,11 +59,30 @@ module Isorun
     private_constant :Import
     class << self
-      def create(&block)
+      # Creates a new context and yields the context as the first argument to
+      # the block.
+      #
+      # @example Creates a new context, imports the default as function
+      #   result = Isorun::Context.create do |context|
+      #     func = context.import.from(module_path)
+      #     func.call("Hello, World!")
+      #   end
+      #
+      # @yield [context] The newly created JavaScript context
+      # @yieldparam [Isorun::Context] context
+      # @yieldreturn [Object, nil] An optional return value from the execution context
+      def create(options = default_options, &block)
         raise "[Isorun::Context] block missing when creating context" unless block
         context = Isorun::Context.new
-        yield(context)
+        context.receiver = options[:receiver] if options[:receiver].present?
+        result = yield(context)
+        context.receiver = nil if options[:receiver].present?
+        result
       end
       # @!method new()
@@ -66,11 +92,28 @@ module Isorun
       def default_options
         {
-          receiver: Isorun.configuration.receiver
+          receiver: nil
         }
       end
     end
+    # Specify items you want to import from the module. If none is specified,
+    # the default export is taken.
+    #
+    # @example Import default export
+    #   result = Isorun::Context.create do |context|
+    #     item = context.import.from(module_path)
+    #   end
+    #
+    # @example Import default export explicitly
+    #   result = Isorun::Context.create do |context|
+    #     item = context.import(:default).from(module_path)
+    #   end
+    #
+    # @example Import various exports
+    #   result = Isorun::Context.create do |context|
+    #     hello, world = context.import(:hello, :world).from(module_path)
+    #   end
     def import(*export_names)
       export_names = [*export_names].map(&:to_s)
       export_names = [:default.to_s] if export_names.empty?
@@ -78,6 +121,7 @@ module Isorun
     end
     # @!method receiver=(receiver)
+    #
     # @param receiver [Proc, nil]
     # @return [Isorun::Context] the newly created context
   end

data/lib/isorun/engine.rb CHANGED Viewed

@@ -12,7 +12,6 @@ module Isorun
     initializer "isorun.helpers", before: :load_config_initializers do
       ActiveSupport.on_load(:action_controller_base) do
-        Rails.logger.debug Isorun::Engine.helpers
         helper Isorun::Engine.helpers
       end
     end

data/lib/isorun/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Isorun
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isorun
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: x86_64-darwin
 authors:
 - Hannes Moser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-31 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.46
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -94,10 +122,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "Import ECMAScript modules into Ruby and use values and functions like
-  \nJavaScript is part of Ruby. Enables easy to set up server-side rendering for\nmodern
-  frontend stacks.\n\nIsorun embeds v8 into Ruby via a native extension built with
-  Rust and\ndeno_core.\n"
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+description: |
+  Import ECMAScript modules into Ruby and use values and functions like
+  JavaScript is part of Ruby. Enables easy to set up server-side rendering for
+  modern frontend stacks.
+  Isorun embeds v8 into Ruby via a native extension built with Rust and
+  deno_core.
 email:
 - box@hannesmoser.at
 executables: []