Module: Funicular::SSR::Runtime

Defined in:
lib/funicular/ssr/runtime.rb

Overview

Loads the PicoRuby (mrblib) framework runtime and the application’s component classes into the CRuby process so the server can build VDOM and serialize it to HTML.

The mrblib runtime is plain Ruby; the only JS access happens inside methods that SSR never calls (mount, patcher, fetch, history, …). ‘Funicular.server = true` makes the few JS-touching entry points (Funicular.start, Router#start, FileUpload.mount, Debug) no-ops.

Constant Summary collapse

MRBLIB_DIR = 
File.expand_path("../../../mrblib", __dir__)
LOAD_ORDER =

Load order is by dependency at class-body evaluation time. Most files reference JS / other classes only inside methods, so only a few real dependencies exist (vdom before html_serializer; styles and vdom before component; component before error_boundary).

%w[
  environment_inquirer
  vdom
  html_serializer
  differ
  patcher
  styles
  debug
  component
  error_boundary
  router
  0_validations
  1_validators
  model
  store
  store_singleton
  store_collection
  form_builder
  http
  cable
  file_upload
  funicular
].freeze

Class Method Summary collapse

Class Method Details

.boot!(source_dir) ⇒ Object

Load the application’s component/model/store/initializer files in the canonical order. Running the initializer registers routes into Funicular.router (server-safe: Funicular.start skips all DOM work).

Funicular model files are loaded so that the constants they define (e.g. Channel, Session) are available when the initializer evaluates ‘load_schemas({ Channel => “channel”, … })`. If a Funicular model shares a name with a same-named ActiveRecord model that Rails has already auto-loaded, Ruby raises TypeError (superclass mismatch). In that case we rescue and continue: the AR constant is already defined and is all that load_schemas needs (it ignores the hash on the server).

Loaded once per process. Restart the server to pick up changes.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/funicular/ssr/runtime.rb', line 72

def boot!(source_dir)
  load_framework!
  return if @app_loaded

  files = Funicular::Compiler.source_files(source_dir.to_s)
  files.each do |file|
    begin
      Kernel.load(file)
    rescue TypeError => e
      # Funicular model name conflicts with an already-loaded AR model.
      # The constant is already defined; safe to skip.
      warn "[Funicular SSR] Skipped #{File.basename(file)}: #{e.message}"
    end
  end
  @app_loaded = true
end

.framework_loaded? ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/funicular/ssr/runtime.rb', line 95

def framework_loaded?
  !!@framework_loaded
end

.load_framework! ⇒ Object

Load the framework runtime once. Idempotent.



49
50
51
52
53
54
55
56
57
 
# File 'lib/funicular/ssr/runtime.rb', line 49

def load_framework!
  return if @framework_loaded

  LOAD_ORDER.each do |name|
    require File.join(MRBLIB_DIR, "#{name}.rb")
  end
  Funicular.server = true
  @framework_loaded = true
end

.reset_app! ⇒ Object

Test/escape hatch: forget loaded application state so a different app (or a reload) can be booted. Does not unload the framework.



91
92
93
 
# File 'lib/funicular/ssr/runtime.rb', line 91

def reset_app!
  @app_loaded = false
end