Class: SvelteOnRails::Configuration

Inherits:
Object
  • Object
show all
Includes:
Lib::WatchAssetChanges
Defined in:
lib/svelte_on_rails/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Lib::WatchAssetChanges

#build_status, #component_mtime_changed?, #fetch_source_files, #fingerprint, #manifest, #vite_build

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/svelte_on_rails/configuration.rb', line 15

def initialize

  @boot_key = SecureRandom.hex(3) # currently not used, more for debugging purposes
  @configs = redis_cache_store_configs
  set_config_defaults

  @component_paths_cache = {}
  @request_metrics = {}

  return unless defined?(Rails.root)

  config_path = Rails.root.join("config", "svelte_on_rails.yml")
  return unless File.exist?(config_path)

  environments = Dir[Rails.root.join('config', 'environments', '*.rb')]
                   .map { |file| File.basename(file, '.rb') }

  configs_base = YAML.load_file(config_path).deep_symbolize_keys

  # merge envrionment specific configs
  current_env = Rails.env.to_sym
  env_configs = configs_base.dup[current_env]
  merged_configs = configs_base.deep_merge(env_configs || {})

  # cleanup
  polished_configs = merged_configs.reject { |k, _| environments.include?(k.to_s) }
  @configs = @configs.merge(polished_configs)

  # DEFAULTS

  rd = @configs[:redis_cache_store] && @configs[:redis_cache_store][:namespace]
  @redis_namespace ||= "#{rd || app_name}:svelte-on-rails:#{Rails.env rescue 'no-env'}"
  @configs[:skip_ssr_header] ||= 'X-Turbo-Request-ID'
  if defined? Redis
    @redis_instance = Redis.new(url: redis_cache_store[:url])
  end

  validate_serialized_configs
  custom_config_validations
  validate_npm_packages
  process_configs
end

Instance Attribute Details

#component_paths_cache ⇒ Object

Returns the value of attribute component_paths_cache.



13
14
15
 
# File 'lib/svelte_on_rails/configuration.rb', line 13

def component_paths_cache
  @component_paths_cache
end

#configs ⇒ Object

Returns the value of attribute configs.



13
14
15
 
# File 'lib/svelte_on_rails/configuration.rb', line 13

def configs
  @configs
end

#redis_namespace ⇒ Object

Returns the value of attribute redis_namespace.



13
14
15
 
# File 'lib/svelte_on_rails/configuration.rb', line 13

def redis_namespace
  @redis_namespace
end

#request_metrics ⇒ Object

Returns the value of attribute request_metrics.



13
14
15
 
# File 'lib/svelte_on_rails/configuration.rb', line 13

def request_metrics
  @request_metrics
end

Class Method Details

.instance ⇒ Object 



9
10
11
 
# File 'lib/svelte_on_rails/configuration.rb', line 9

def self.instance
  @instance ||= new
end

Instance Method Details

#assets_folder_path ⇒ Object 



125
126
127
 
# File 'lib/svelte_on_rails/configuration.rb', line 125

def assets_folder_path
  rails_root.join('public', 'svelte-ssr')
end

#build_status_file ⇒ Object 



133
134
135
 
# File 'lib/svelte_on_rails/configuration.rb', line 133

def build_status_file
  assets_folder_path.join('.vite', 'build-status.json')
end

#components_root ⇒ Object 



121
122
123
 
# File 'lib/svelte_on_rails/configuration.rb', line 121

def components_root
  File.join(@configs[:vite_source_dir], @configs[:components_subdir])
end

#debug_log(debug, component_basename, subject, show_component_name: true, &block) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/svelte_on_rails/configuration.rb', line 77

def debug_log(debug, component_basename, subject, show_component_name: true, &block)
  msg = if show_component_name
          "  [SOR] #{component_basename}.svelte #{subject}"
        else
          "  [SOR] #{subject}"
        end
  if !block_given?
    Rails.logger.debug(msg)
  else
    if debug || @configs[:debug]
      r = nil
      sec = Benchmark.realtime do
        r = block.call
      end
      Rails.logger.debug("#{msg} (#{(sec * 1000.0).round(2)}ms)")
      r
    else
      block.call
    end
  end
end

#dev_module_map_path ⇒ Object 



137
138
139
 
# File 'lib/svelte_on_rails/configuration.rb', line 137

def dev_module_map_path
  assets_folder_path.join('.vite', 'dev-module-map.json')
end

#initialize_request_metrics(request_uuid) ⇒ Object 



151
152
153
154
155
156
157
158
159
 
# File 'lib/svelte_on_rails/configuration.rb', line 151

def initialize_request_metrics(request_uuid)
  return if request_uuid == @request_metrics[:request_uuid]

  @request_metrics = {
    request_uuid: request_uuid,
    total_time: 0.0
  }

end

#manifest_json_path ⇒ Object 



129
130
131
 
# File 'lib/svelte_on_rails/configuration.rb', line 129

def manifest_json_path
  assets_folder_path.join('.vite', 'manifest.json')
end

#node_bin_path ⇒ Object 



141
142
143
 
# File 'lib/svelte_on_rails/configuration.rb', line 141

def node_bin_path
  @node_bin_path ||= resolve_node_bin_path
end

#node_version_test ⇒ Object 



161
162
163
 
# File 'lib/svelte_on_rails/configuration.rb', line 161

def node_version_test
  `#{node_bin_path} --version`.chomp
end

#npm_package_version_test ⇒ Object 



165
166
167
168
169
 
# File 'lib/svelte_on_rails/configuration.rb', line 165

def npm_package_version_test
  JSON.parse(File.read(Rails.root.join('node_modules/@csedl/svelte-on-rails/package.json')))['version']
rescue
  nil
end

#process_configs ⇒ Object 



171
172
173
174
175
176
 
# File 'lib/svelte_on_rails/configuration.rb', line 171

def process_configs
  ex = @configs[:cache_expires_in]
  if ex
    @configs[:cache_expires_in] = ex.split('.').first.to_i.send(ex.split('.').last)
  end
end

#rails_root(root_url = nil) ⇒ Object 



117
118
119
 
# File 'lib/svelte_on_rails/configuration.rb', line 117

def rails_root(root_url = nil)
  root_url || Rails.root
end

#redis_cache_store ⇒ Object 



65
66
67
 
# File 'lib/svelte_on_rails/configuration.rb', line 65

def redis_cache_store
  (@configs[:redis_cache_store] || {}).transform_keys(&:to_sym)
end

#redis_instance ⇒ Object 



69
70
71
 
# File 'lib/svelte_on_rails/configuration.rb', line 69

def redis_instance
  @redis_instance
end

#set_config_defaults ⇒ Object 



58
59
60
61
62
63
 
# File 'lib/svelte_on_rails/configuration.rb', line 58

def set_config_defaults
  @configs[:ssr_server] = true
  @configs[:ssr_server_workers] = 1
  @configs[:ssr_fallback_renderer] = false
  @configs[:ssr_error_tag] = true
end

#ssr_server_bin_path ⇒ Object 



145
146
147
148
149
 
# File 'lib/svelte_on_rails/configuration.rb', line 145

def ssr_server_bin_path
  wk = @configs[:ssr_server_workers]
  str = wk > 1 ? 'cluster' : 'server'
  Rails.root.join(Pathname("node_modules/@csedl/svelte-on-rails/bin/svelte-ssr-#{str}.js"))
end

#to_svelte_benchmark_log(subject, &block) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/svelte_on_rails/configuration.rb', line 99

def to_svelte_benchmark_log(subject, &block)
  msg = "  [SOR] to_svelte #{subject}"
  if !block_given?
    Rails.logger.debug(msg)
  else
    if @configs[:debug]
      r = nil
      sec = Benchmark.realtime do
        r = block.call
      end
      Rails.logger.debug("#{msg} (#{(sec * 1000.0).round(2)}ms)")
      r
    else
      block.call
    end
  end
end

#watch_changes? ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/svelte_on_rails/configuration.rb', line 73

def watch_changes?
  @configs[:watch_changes] == true
end