svelte-on-rails 14.4.0 → 14.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f41c1763ffa52bdf71790ca32a11bcd6268a44d9cd0d5ada872dc56d70ee954b
-  data.tar.gz: 02ead98b87f000e4e58f1b1b8e51578a901faea729ba28a7c505e69f5de15842
+  metadata.gz: d12a749b2285a777b0f61a381785f60a076e089b19cf1849d71ca4481460546a
+  data.tar.gz: 4c8d743ad0a80a6e64a4c3273e0c0b0360faf01f2f5c9497f8eb9aee4cc99540
 SHA512:
-  metadata.gz: 1e2e47f05ac02bed21ebc112f3cc6803313f8dfbedade0d59a7da1904cc6d3e00195501d113f2f6acb6fe47d70b54a1717bde927e13d41a90df29e6128b59773
-  data.tar.gz: 80df87c8d6b31be2cd8cfaa142c19d379d58b12327810271ffcb4766bab8c7f62eb5331f4b87ebbe0c32fc1b60db294cf63198d83bdfd9c61e0019b486a3f068
+  metadata.gz: cc42096e49e80ef471749fe347e79ad5caef7c0824ddd38571dbf898936c8e93130a595073ce654f4380de5834070017c6dbda1c3dc8b55f6495e4eb08c96214
+  data.tar.gz: 14887f7e4edbe5c2078378cdb45f735099bc2cced66f1a74d25b800ce2a53ec7e906572976f41098f1846041f3522f5579e2b5a7af4d0b889e7d80317b4be62e

data/lib/svelte-on-rails.rb

@@ -7,8 +7,8 @@ require "svelte_on_rails/ssr_server"
 
 require "svelte_on_rails/railtie" if defined?(Rails)
 
-require "svelte_on_rails/renderer/renderer"
 
+require "svelte_on_rails/lib/fallback_renderer"
 require "svelte_on_rails/lib/utils"
 require "svelte_on_rails/lib/metrics"
 require "svelte_on_rails/lib/log_patch"
@@ -33,7 +33,6 @@ require 'generators/showcase_generator'
 
 require 'digest/xxhash'
 require 'benchmark'
-#require 'faraday'
 
 module SvelteOnRails
   class << self

data/lib/svelte_on_rails/lib/fallback_renderer.rb

@@ -0,0 +1,89 @@
+module SvelteOnRails
+  module Lib
+    class FallbackRenderer
+
+      require 'open3'
+      require 'base64'
+      require 'json'
+
+      def self.render(paths, props, debug)
+        utils = SvelteOnRails::Lib::Utils
+        cnf = SvelteOnRails::Configuration.instance
+        mn = cnf.manifest(debug, paths[:name])
+        manifest = mn[paths[:path]]
+
+        if manifest.nil?
+          raise "[SOR] #{paths[:file_basename]}: ERROR: No manifest found!\nAvailable keys in current manifest.json are:\n\n+++\n • #{cnf.manifest.keys.join("\n • ")}\n+++\n."
+        end
+
+        cmd = [
+          cnf.node_bin_path,
+          cnf.rails_root.join('node_modules/@csedl/svelte-on-rails/src/ssr/render.js'),
+          cnf.assets_folder_path.join(manifest['file'])
+        ].join(' ')
+
+        stdout, stderr, status = Open3.capture3(
+          cmd,
+          stdin_data: props.to_json,
+          chdir: cnf.rails_root,
+        )
+
+        ary = stdout.split('$$ResponseSeparator$$')
+
+        js = JSON.parse(ary.second || {})
+        if js['status'] == 'SUCCESS'
+
+          htm = js['html'].delete_prefix("<!--[-->").delete_suffix("<!--]-->")
+
+          {
+            success: true,
+            html: htm,
+            head: js['head'],
+          }
+        else
+
+          utils = SvelteOnRails::Lib::Utils
+          utils.error_log(
+            "RENDER #{paths[:file_basename]}.svelte",
+            [
+              "command:\n#{cmd}",
+              "stdout:\n#{stdout.split('$$ResponseSeparator$$').first.strip}",
+              "stderr:\n#{stderr.strip}",
+            ]
+          )
+
+          { success: false }
+        end
+
+        # unless ary.length == 2 || (JSON.parse(ary.second) rescue true)
+        #   utils = SvelteOnRails::Lib::Utils
+        #   utils.error_log(
+        #     "RENDER #{paths[:file_basename]}.svelte",
+        #     [
+        #       "command:\n#{cmd}",
+        #       "stdout:\n#{stdout}",
+        #       "stderr:\n#{stderr}",
+        #     ]
+        #   )
+        #   return { success: false }
+        # end
+
+        # begin
+        #
+        #   raw_response = JSON.parse(ary[1])
+        #
+        #   htm = raw_response['html'].delete_prefix("<!--[-->").delete_suffix("<!--]-->")
+        #
+        #   return {
+        #     success: true,
+        #     html: htm,
+        #     head: raw_response['head'],
+        #   }
+        #
+        # rescue => e
+        #   raise "MY_ERR => #{e}\n\n+++\n#{e.backtrace.join("\n")}\n+++"
+        # end
+      end
+    end
+  end
+end

data/lib/svelte_on_rails/lib/metrics.rb

@@ -7,6 +7,8 @@ module SvelteOnRails
 
         if !cnf.build_status['passed']
           'SVELTE BUILD FAILED!'
+        elsif m[:render_failed]
+          'SVELTE RENDER FAILED!'
         else
 
           w = (cnf.watch_changes? ? cnf.build_status['warnings_count'] : nil)

data/lib/svelte_on_rails/lib/utils.rb

@@ -93,6 +93,20 @@ module SvelteOnRails
           0.0
         end
       end
+
+      def self.error_log(title, messages)
+        sep_char = '='
+        sep_line = sep_char*100
+        inner_sep = '-'*100
+        puts sep_line
+        puts "ERROR: #{title}"
+        puts sep_line
+        puts messages.join("\n#{inner_sep}\n")
+        puts sep_line
+        puts "END #{title.downcase}"
+        puts sep_line
+        $stdout.flush
+      end
     end
   end
 end

data/lib/svelte_on_rails/lib/view_helper_support.rb

@@ -23,17 +23,33 @@ module SvelteOnRails
 
           if !@conf.manifest_json_path.exist? ||
              !@conf.dev_module_map_path.exist? ||
-             @conf.build_status['mtime'].to_f != @utils.manifest_file_mtime
+
+             @conf.build_status['mtime'].to_f != @utils.manifest_file_mtime ||
+             # if a developer has run build from the console, we must update the build-status object
+             # this is importand for having reliable error-messages
+
+             (!@conf.build_status['passed'] && !@conf.request_metrics[:build_failed])
+            # when build has failed the developer sees the error message
+            # at this point it is importand to see the build-error in the logs
+            # but only ONCE for a request, so we check metrics too
+
             run_vite_build
+
+            return unless @conf.build_status['passed']
           end
 
-          validate_options
+          # now we are sure to have a valid manifest
+          # and are able to collect the dependend source files,
+          # check theyr mtime
+          # and run a build if something has changed (is only the case if the build above not was run)
           ensure_valid_component_and_manifest!(component)
-
           if @conf.component_mtime_changed?(component_paths[:path], debug?, component_paths[:file_basename])
             run_vite_build
           end
 
+          # finally, validate the given options
+          validate_options
+
         end
 
         if @conf.configs[:cache_warmer] && caching
@@ -118,9 +134,12 @@ module SvelteOnRails
                 @cached_content.html_safe
               else
                 msg = "Rendered"
+                @skip_caching = false
                 @conf.debug_log(debug?, component_paths[:name], "rendered and stored to cache (key: «#{cache_key}»)") do
                   r = view_context.instance_eval(&block)
-                  @conf.redis_instance.set(cache_key, r)
+                  unless @skip_caching
+                    @conf.redis_instance.set(cache_key, r)
+                  end
                   r
                 end
               end
@@ -140,7 +159,15 @@ module SvelteOnRails
 
       def set_request_metrics(action_key)
 
-        if @conf.watch_changes? && ![:build, :build_failed, :from_cache, :empty, :rendered].include?(action_key)
+        if @conf.watch_changes? &&
+           ![
+             :build,
+             :build_failed,
+             :render_failed,
+             :from_cache,
+             :empty,
+             :rendered
+           ].include?(action_key)
           raise "[SOR] set_request_metrics: invalid action_key"
         end
 

data/lib/svelte_on_rails/ssr_server.rb

@@ -106,20 +106,27 @@ module SvelteOnRails
       shorten_logfile
 
       raw_response = parse_body_json(response)
-      htm = if raw_response['error']
-              <<~HTML
-                <div style="border: 1px solid red; padding: 5px; margin: 5px;">
-                   <strong style="color: red;">#{raw_response['error']}</strong>
-                   <p>#{raw_response['details']}</p>
-                </div>/
-              HTML
-            else
-              raw_response['html'].to_s.delete_prefix("<!--[-->").delete_suffix("<!--]-->")
-            end
-      {
-        html: htm,
-        head: raw_response['head'].to_s,
-      }
+      if raw_response['status'] == 'SUCCESS'
+        htm = raw_response['html'].to_s.delete_prefix("<!--[-->").delete_suffix("<!--]-->")
+
+        {
+          success: true,
+          html: htm,
+          head: raw_response['head'].to_s,
+        }
+      else
+        utils = SvelteOnRails::Lib::Utils
+        utils.error_log(
+          "Render #{component[:file_basename]}.svelte",
+          [
+            raw_response['errorLog'].join("\n")
+          ]
+        )
+        {
+          success: false,
+        }
+      end
+
     end
 
     def parse_body_json(response_string)

data/lib/svelte_on_rails/view_helpers.rb

@@ -16,7 +16,7 @@ module SvelteOnRails
 
       if support.ssr?
         if config.watch_changes? && !config.build_status['passed']
-          render_build_failed_tag(support, wrapper_html, props)
+          build_failed_tag(support, wrapper_html, props)
         elsif caching
           support.set_request_metrics(:from_cache)
           support.render_cached(self) do
@@ -38,28 +38,22 @@ module SvelteOnRails
 
       if support.ssr?
 
-        support.set_request_metrics(:rendered)
-
-        ssr_result = if !support.conf.build_status['passed']
-                       wrapper_style = 'color: white; background-color: red; padding: 10px; border-radius: 10px; display:inline-block; font-size:22px;'
-                       html = <<~HTML
-                         <strong style="#{wrapper_style}">
-                           <p style="margin:4px;">Vite build failed.</p>
-                           <p style="margin:4px;">Please run «npm run build:ssr» to fix.</p>
-                         </strong>
-                       HTML
-                       {
-                         html: html.html_safe,
-                         head: ''.html_safe
-                       }
-                     elsif SvelteOnRails::SsrServer.instance.alive?
+        ssr_result = if SvelteOnRails::SsrServer.instance.alive?
                        SvelteOnRails::SsrServer.instance.render(support.component_paths, props, support.debug?)
                      else
-                       SvelteOnRails::Renderer.render(support.component_paths, props, support.debug?)
+                       SvelteOnRails::Lib::FallbackRenderer.render(support.component_paths, props, support.debug?)
                      end
-        content_tag(:div, support.tag_attributes(html_options, props)) do
-          concat(ssr_result[:head].html_safe)
-          concat(ssr_result[:html].html_safe)
+
+        if ssr_result[:success]
+          support.set_request_metrics(:rendered)
+          content_tag(:div, support.tag_attributes(html_options, props)) do
+            concat(ssr_result[:head].html_safe)
+            concat(ssr_result[:html].html_safe)
+          end
+        else
+          support.set_request_metrics(:render_failed)
+          support.instance_variable_set(:@skip_caching, true)
+          render_failed_tag(support, html_options, props)
         end
 
       else
@@ -76,26 +70,45 @@ module SvelteOnRails
       content_tag(:div, support.tag_attributes(html_options, props)) {}
     end
 
-    def render_build_failed_tag(support, html_options, props)
+    def build_failed_tag(support, html_options, props)
 
-      support.set_request_metrics(:empty)
+      # support.set_request_metrics(:empty)
 
       content_tag(:div, support.tag_attributes(html_options, props)) do
-        style = [
-          'background-color:red',
-          'color:white',
-          'padding:8px',
-          'border-radius:8px',
-          'font-size:16px',
-          'font-weight:bold',
-          'border:3px solid white'
-        ]
-        content_tag(:span, style: style.join(';')) do
+        content_tag(
+          :span,
+          class: 'svelte-on-rails-render-error',
+          style: failed_tag_style
+        ) do
           'BUILD FAILED'
         end
       end
     end
 
+    def render_failed_tag(support, html_options, props)
+      content_tag(:div, support.tag_attributes(html_options, props)) do
+        content_tag(
+          :span,
+          class: 'svelte-on-rails-render-error',
+          style: failed_tag_style
+        ) do
+          'RENDER FAILED'
+        end
+      end
+    end
+
+    def failed_tag_style
+      [
+        'background-color:red',
+        'color:white',
+        'padding:8px',
+        'border-radius:8px',
+        'font-size:16px',
+        'font-weight:bold',
+        'border:3px solid white'
+      ].join(';')
+    end
+
     def calling_view_dir
       rails_views_path = Rails.root.join('app', 'views').to_s
       raw_path_full = caller_locations.find do |loc|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svelte-on-rails
 version: !ruby/object:Gem::Version
-  version: 14.4.0
+  version: 14.5.0
 platform: ruby
 authors:
 - Christian Sedlmair
@@ -99,6 +99,7 @@ files:
 - lib/svelte_on_rails/installer/utils.rb
 - lib/svelte_on_rails/lib/cache_warmer.rb
 - lib/svelte_on_rails/lib/development_utils.rb
+- lib/svelte_on_rails/lib/fallback_renderer.rb
 - lib/svelte_on_rails/lib/log_patch.rb
 - lib/svelte_on_rails/lib/metrics.rb
 - lib/svelte_on_rails/lib/to_svelte_labels.rb
@@ -108,7 +109,6 @@ files:
 - lib/svelte_on_rails/lib/view_helper_support.rb
 - lib/svelte_on_rails/lib/watch_asset_changes.rb
 - lib/svelte_on_rails/railtie.rb
-- lib/svelte_on_rails/renderer/renderer.rb
 - lib/svelte_on_rails/ssr_server.rb
 - lib/svelte_on_rails/turbo_stream.rb
 - lib/svelte_on_rails/view_helpers.rb

data/lib/svelte_on_rails/renderer/renderer.rb

@@ -1,64 +0,0 @@
-module SvelteOnRails
-  class
-  Renderer
-
-    require 'open3'
-    require 'base64'
-    require 'json'
-
-    def self.render(paths, props, debug)
-      utils = SvelteOnRails::Lib::Utils
-      cnf = SvelteOnRails::Configuration.instance
-      mn = cnf.manifest(debug, paths[:name])
-      manifest = mn[paths[:path]]
-
-      if manifest.nil?
-        raise "[SOR] #{paths[:file_basename]}: ERROR: No manifest found!\nAvailable keys in current manifest.json are:\n\n+++\n • #{cnf.manifest.keys.join("\n • ")}\n+++\n."
-      end
-
-      cmd = [
-        cnf.node_bin_path,
-        cnf.rails_root.join('node_modules/@csedl/svelte-on-rails/src/ssr/render.js'),
-        cnf.assets_folder_path.join(manifest['file'])
-      ].join(' ')
-
-      stdout, stderr, status = Open3.capture3(
-        cmd,
-        stdin_data: props.to_json,
-        chdir: cnf.rails_root,
-      )
-
-      ary = stdout.split('$$ResponseSeparator$$')
-      ary_t = ary.first.split('<time>')
-      start = ary_t.first.to_f
-      completed = ary_t.last.to_f
-      cnf.debug_log(debug, paths[:name], "Render Server-side (#{(completed - start).round(2)}ms)")
-
-      unless ary.length == 2
-        raise "[SOR] #{paths[:name]}: RENDER ERROR\n\ncommand:\n+++\n#{cmd}\n+++\n\nstdout:\n+++\n#{stdout}+++\n\n\nstderr:\n+++\n#{stderr}+++"
-      end
-
-      begin
-
-        unless status.to_s.match(/^pid [0-9]+ exit 0$/)
-          cmp = "#{paths[:path]} was returned «#{status.to_s}»\n\n"
-          msg = "#{cmp}output from render.js (stderr) =>\n+++\n" + stderr + "+++\n\nRender Svelte Server-side =>\n#{cmd}\n\n"
-          utils.puts_warning(msg)
-        end
-
-        raw_response = JSON.parse(ary[1])
-
-        htm = raw_response['html'].delete_prefix("<!--[-->").delete_suffix("<!--]-->")
-
-        return {
-          html: htm,
-          head: raw_response['head'],
-        }
-
-      rescue => e
-        raise "MY_ERR => #{e}\n\n+++\n#{e.backtrace.join("\n")}\n+++"
-      end
-    end
-
-  end
-end