isomorfeus-asset-manager 0.12.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e92ad4c34e5b1c973ca4c16b8604fe46148c8e2eaad20b3e7dbe1f380094b13f
+  data.tar.gz: 4862aeaf75d7dc1394fc51c7948fc0c62d91b121c4ec971475b952057c21bf8e
+SHA512:
+  metadata.gz: c746fdab0004a98d7a69d1b7e160b1334ba3a1c2e2eb9e8233ef524dd137b0bd45997c1f148168aae4afa27c6f92fc90d8aa2eabe2b69dbe7dfc971efd07d540
+  data.tar.gz: c76e75768ee2f5284a8e3b3745ef1e21a5799c4e7ff1134919fa8b963080398cabfb1717dfce18eaa9d569ceb738a0feb89f718fd65faf78cefa6504664e0d4d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jan Biedermann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,12 @@
+# isomorfeus-asset-manager
+
+Convenient and well performing on demand asset bundling for the isomorfeus framework project, internally using esbuild (esbuild-wasm).
+
+Version follows esbuild version: 0.12.x comes with esbuild 0.12.y.
+
+No need to install esbuild separately, everything bundled ready to go.
+However, if within the project the 'esbuild' npm package is installed in node_modules, that version will be used instead.
+
+### Community and Support
+At the [Isomorfeus Framework Project](http://isomorfeus.com) 
+

data/lib/iso_opal.rb

@@ -0,0 +1,10 @@
+module IsoOpal
+  # Just to prevent Opal from freezing Opal.paths
+  def self.paths
+    Opal.instance_variable_get(:@paths)
+  end
+
+  def self.paths_include?(path)
+    paths.include?(path)
+  end
+end

data/lib/isomorfeus/asset_manager/asset.rb

@@ -0,0 +1,67 @@
+module Isomorfeus
+  class AssetManager
+    class Asset
+      attr_reader :bundle, :bundle_size
+      attr_reader :bundle_gz, :bundle_gz_size
+      attr_reader :bundle_map
+      attr_reader :bundle_map_gz
+      attr_reader :mtime, :ruby_imports, :target
+
+      def initialize(target = :browser)
+        raise "Unknown asset target!" unless %i[browser node].include?(target)
+        @target = target
+        @bundled = false
+        @js_imports = []
+        @ruby_imports = []
+      end
+
+      def add_js_import(*args)
+        @js_imports << Isomorfeus::AssetManager::JsImport.new(*args)
+      end
+
+      def add_ruby_import(*args)
+        @ruby_imports << Isomorfeus::AssetManager::RubyImport.new(*args)
+      end
+
+      def bundle=(b)  
+        @bundled = true
+        @bundle = b
+        @bundle_size = @bundle.size
+        unless @target == :node
+          @bundle_gz = Zlib::gzip(b, level: Zlib::BEST_COMPRESSION) 
+          @bundle_gz_size = @bundle_gz.size
+        end
+        @mtime = Time.now
+        @bundle
+      end
+
+      def bundle_map=(m)  
+        @bundled = true
+        @bundle_map = m
+        @bundle_map_gz = Zlib::gzip(m, level: Zlib::BEST_COMPRESSION) unless @target == :node
+        @mtime = Time.now unless @mtime
+        @bundle_map
+      end
+
+      def bundled?
+        @bundled
+      end
+
+      def ruby_modules
+        @ruby_imports.map(&:module_name)
+      end
+
+      def to_s
+        js = @target == :node ? '' : "if (typeof globalThis !== 'undefined' && typeof global === 'undefined') { globalThis.global = globalThis; }\n"
+        unless @js_imports.empty?
+          js << "#{@js_imports.map(&:to_s).join("\n")}"
+        end
+        js << "\n" if !@js_imports.empty? && !@ruby_imports.empty?
+        unless @ruby_imports.empty?
+          js << "#{@ruby_imports.map(&:to_s).join("\n")}"
+        end
+        js
+      end
+    end
+  end
+end

data/lib/isomorfeus/asset_manager/config.rb

@@ -0,0 +1,69 @@
+module Isomorfeus
+  # available settings
+  if RUBY_ENGINE == 'opal'
+    add_client_option(:assets_websocket_path)
+    add_client_option(:assets_path)
+    add_client_option(:opal_assets_path)
+  else
+    class << self
+      attr_reader :env
+      attr_accessor :root
+      attr_accessor :app_root
+      attr_accessor :assets_path
+      attr_accessor :node_paths
+      attr_accessor :assets
+
+      def add_web_js_import(*args)
+        Isomorfeus.assets['web.js'].add_js_import(*args)
+      end
+  
+      def add_ssr_js_import(*args)
+        Isomorfeus.assets['ssr.js'].add_js_import(*args)
+      end
+  
+      def add_common_js_import(*args)
+        Isomorfeus.assets['web.js'].add_js_import(*args)
+        Isomorfeus.assets['ssr.js'].add_js_import(*args)
+      end
+  
+      def add_web_ruby_import(*args)
+        Isomorfeus.assets['web.js'].add_ruby_import(*args)
+      end
+  
+      def add_ssr_ruby_import(*args)
+        Isomorfeus.assets['ssr.js'].add_ruby_import(*args)
+      end
+  
+      def add_common_ruby_import(*args)
+        Isomorfeus.assets['web.js'].add_ruby_import(*args)
+        Isomorfeus.assets['ssr.js'].add_ruby_import(*args)
+      end
+
+      # client side env is initialized in isomorfeus-preact
+      def env=(env_string)
+        @env = env_string ? env_string.to_s : 'development'
+        @development = (@env == 'development') ? true : false
+        @production = (@env == 'production') ? true : false
+        @test = (@env == 'test') ? true : false
+      end
+
+      def development?
+        @development
+      end
+
+      def production?
+        @production
+      end
+
+      def test?
+        @test
+      end
+    end
+  end
+
+  self.assets_path = '/assets'
+  self.assets = {
+    'web.js' => Isomorfeus::AssetManager::Asset.new(:browser),
+    'ssr.js' => Isomorfeus::AssetManager::Asset.new(:node)
+  }
+end

data/lib/isomorfeus/asset_manager/js_import.rb

@@ -0,0 +1,59 @@
+module Isomorfeus
+  class AssetManager
+    class JsImport
+      def initialize(package, js_constant = nil, imported_constants = nil, js_sub_constant = nil, import_assignment = nil)
+        @package = package
+        @js_constant = js_constant
+        @js_sub_constant = js_sub_constant
+        @imported_constants = imported_constants
+        @import_assignment = import_assignment
+      end
+
+      def to_s
+        js = ''
+        if @imported_constants
+          if @js_sub_constant
+            js << "import { #{@imported_constants} as #{@js_constant}_#{@js_sub_constant} } from \"#{@package}\";\n"
+          else
+            if @imported_constants.is_a?(String)
+              js << "import #{@imported_constants} from \"#{@package}\";\n"
+            else
+              js << "import { #{@imported_constants.join(", ")} } from \"#{@package}\";\n"
+            end
+          end
+          if @js_constant
+            js << "if (!global.#{@js_constant}) { global.#{@js_constant} = {}; }\n" if @js_sub_constant
+            if @js_constant
+              if @js_sub_constant
+                js << "global.#{@js_constant}.#{@js_sub_constant} = #{@js_constant}_#{@js_sub_constant};\n"
+              else
+                if @imported_constants.is_a?(String)
+                  js << "global.#{@js_constant}.#{@import_assignment ? @import_assignment : @imported_constants} = #{@imported_constants};\n"
+                else
+                  @imported_constants.each do |imported_constant|
+                    js << "global.#{@js_constant}.#{@import_assignment ? @import_assignment : imported_constant} = #{imported_constant};\n"
+                  end
+                end
+              end
+            end
+          else
+            @imported_constants.each do |imported_constant|
+              js << "global.#{imported_constant} = #{imported_constant};\n"
+            end
+          end
+        elsif @js_constant.nil?
+          js << "import \"#{@package}\";\n"
+        else
+          if @js_constant[0] == @js_constant[0].upcase
+            js << "import * as #{@js_constant} from \"#{@package}\";\n"
+            js << "global.#{@js_constant} = #{@js_constant};\n"
+          else
+            js << "import #{@js_constant} from \"#{@package}\";\n"
+            js << "global.#{@js_constant} = #{@js_constant};\n"
+          end
+        end
+        js
+      end
+    end
+  end
+end

data/lib/isomorfeus/asset_manager/portfolio.rb

@@ -0,0 +1,46 @@
+module Isomorfeus
+  class AssetManager
+    class Portfolio
+      def self.get_load_path_entries(path, filter)
+        path_entries = []
+        return [] unless Dir.exist?(path)
+        dir_entries = Dir.entries(path)
+        dir_entries.each do |entry|
+          next if entry == '.'
+          next if entry == '..'
+          next unless entry
+          absolute_path = File.join(path, entry)
+          if File.directory?(absolute_path)
+            more_path_entries = get_load_path_entries(absolute_path, filter)
+            path_entries.push(*more_path_entries) if more_path_entries.size > 0
+          elsif (absolute_path.end_with?('.rb') || absolute_path.end_with?('.js')) && File.file?(absolute_path)
+            push_entry = true
+            if filter && filter.size > 0
+              filter.each do |filter_entry|
+                push_entry = false if absolute_path.end_with?(filter_entry)
+              end
+            end
+            path_entries.push(absolute_path) if push_entry
+          end
+        end
+        path_entries
+      end
+
+      def self.get_load_paths_json(*filter)
+        cwd = Dir.pwd
+
+        load_paths = Opal.paths.uniq
+        load_path_entries = []
+
+        load_paths.each do |path|
+          next if path.start_with?(cwd)
+          more_path_entries = get_load_path_entries(path, filter)
+          load_path_entries.push(*more_path_entries) if more_path_entries.size > 0
+        end
+
+        cache_obj = { 'opal_load_paths' => load_paths, 'opal_load_path_entries' => load_path_entries }
+        Oj.dump(cache_obj, mode: :strict, indent: 2)
+      end
+    end
+  end
+end

data/lib/isomorfeus/asset_manager/rack_middleware.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Isomorfeus
+  class AssetManager
+    class RackMiddleware
+      WS_RESPONSE = [0, {}, []]
+      attr_reader :asset_manager
+
+      def initialize(app)
+        @app = app
+        @asset_manager = Isomorfeus::AssetManager.new
+        @compressible_types = %w[application/javascript text/javascript]
+        if Isomorfeus.assets_path.end_with?('/')
+          @assets_path = Isomorfeus.assets_path
+          @assets_path_size = @assets_path.size
+        else
+          @assets_path = Isomorfeus.assets_path + '/'
+          @assets_path_size = @assets_path.size
+        end
+      end
+
+      def call(env)
+        begin
+          path_info = env['PATH_INFO']
+          if path_info.start_with?(@assets_path)
+            asset_key = path_info[@assets_path_size..-1]
+
+            # get js
+            if Isomorfeus.assets.has_key?(asset_key)
+              asset = Isomorfeus.assets[asset_key]
+              if asset && asset.target != :node
+                asset_manager.transition(asset_key, asset)
+                headers = {}
+                headers['Last-Modified'] = asset.mtime
+                headers[Rack::CONTENT_TYPE] = 'application/javascript'
+                if should_gzip?(env)
+                  headers['Content-Encoding'] = "gzip"
+                  headers[Rack::CONTENT_LENGTH] = asset.bundle_gz_size
+                  return [200, headers, asset.bundle_gz]
+                else
+                  headers[Rack::CONTENT_LENGTH] = asset.bundle_size
+                  return [200, {}, asset.bundle]
+                end              
+              end
+            
+            # get source map
+            elsif asset_key.end_with?('.js.map')
+              asset = Isomorfeus.assets[asset_key[0..-5]]
+              if asset && asset.target != :node
+                asset_manager.transition(asset_key, asset) unless asset.bundled?
+                headers = {}
+                headers['Last-Modified'] = asset.mtime
+                headers[Rack::CONTENT_TYPE] = 'application/json'
+                if should_gzip?(env)
+                  headers['Content-Encoding'] = "gzip"
+                  headers[Rack::CONTENT_LENGTH] = asset.bundle_map_gz.size
+                  return [200, headers, asset.bundle_map_gz]
+                else
+                  headers[Rack::CONTENT_LENGTH] = asset.bundle_map.size
+                  return [200, {}, asset.bundle_map]
+                end 
+              end
+            end
+            # elsif Isomorfeus.development? && path_info == Isomorfeus.api_asset_hmr_socket_path
+            #   if env['rack.upgrade?'] == :websocket
+            #     env['rack.upgrade'] = Isomorfeus::AssetManager::ServerSocketProcessor.new
+            #   end
+            #   WS_RESPONSE
+          end
+        rescue Exception => e
+          STDERR.puts "#{e}\n#{e.backtrace.join("\n")}"
+          @app.call(env)
+        end
+        @app.call(env)
+      end
+
+      def should_gzip?(env)
+        return true if env.has_key?('HTTP_ACCEPT_ENCODING') && env['HTTP_ACCEPT_ENCODING'].match?(/\bgzip\b/)
+        return false if /\bno-transform\b/.match?(env[Rack::CACHE_CONTROL].to_s) || env['Content-Encoding']&.!~(/\bidentity\b/)
+        return false if @compressible_types && !(env.has_key?(Rack::CONTENT_TYPE) && @compressible_types.include?(env[Rack::CONTENT_TYPE][/[^;]*/]))
+        true
+      end
+    end
+  end
+end

data/lib/isomorfeus/asset_manager/ruby_import.rb

@@ -0,0 +1,33 @@
+module Isomorfeus
+  class AssetManager
+    class RubyImport
+      attr_reader :module_name
+
+      def initialize(ruby_module)
+        @ruby_module = ruby_module.end_with?('.rb') ? ruby_module : ruby_module + '.rb'
+        @module_name = @ruby_module[0..-4]
+        @import_name = @module_name.tr('/', '_')
+      end
+
+      def resolved_path
+        @resolved_path ||= resolve_path
+      end
+
+      def to_s
+        "import(\"./#{@module_name}.js\");\n"
+      end
+
+      private
+
+      def resolve_path
+        split_ruby_path = @ruby_module.split('/')
+        Opal.paths.each do |path|
+          file = File.expand_path(File.join(*path.split('/').concat(split_ruby_path)))
+          return file if File.exist?(file)
+        end
+        STDERR.puts "#{self.class.name}: unable to resolve ruby module #{@module_name}"
+        nil
+      end
+    end
+  end
+end

data/lib/isomorfeus/asset_manager/server_socket_processor.rb

@@ -0,0 +1,55 @@
+module Isomorfeus
+  class AssetManager
+    class ServerSocketProcessor
+      # include Isomorfeus::Transport::ServerProcessor
+
+      # def on_message(client, data)
+      #   # TODO
+      #   if Isomorfeus.development?
+      #     write_lock = Isomorfeus.zeitwerk_lock.try_write_lock
+      #     if write_lock
+      #       Isomorfeus.zeitwerk.reload
+      #       Isomorfeus.zeitwerk_lock.release_write_lock
+      #     end
+      #     Isomorfeus.zeitwerk_lock.acquire_read_lock
+      #   end
+      #   request_hash = Oj.load(data, mode: :strict)
+      #   handler_instance_cache = {}
+      #   response_agent_array = []
+      #   Thread.current[:isomorfeus_user] = user(client)
+      #   Thread.current[:isomorfeus_pub_sub_client] = client
+      #   process_request(request_hash, handler_instance_cache, response_agent_array)
+      #   handler_instance_cache.each_value do |handler|
+      #     handler.resolve if handler.resolving?
+      #   end
+      #   result = {}
+      #   response_agent_array.each do |response_agent|
+      #     result.deep_merge!(response_agent.result)
+      #   end
+      #   client.write Oj.dump(result, mode: :strict) unless result.empty?
+      # ensure
+      #   Thread.current[:isomorfeus_user] = nil
+      #   Thread.current[:isomorfeus_pub_sub_client] = nil
+      #   Isomorfeus.zeitwerk_lock.release_read_lock if Isomorfeus.development?
+      # end
+
+      # def on_close(client)
+      #   # nothing for now
+      # end
+
+      # def on_open(client)
+      #   # nothing for now
+      # end
+
+      # def on_shutdown(client)
+      #   # nothing for now
+      # end
+
+      # def user(client)
+      #   current_user = client.instance_variable_get(:@isomorfeus_user)
+      #   return current_user if current_user
+      #   Anonymous.new
+      # end
+    end
+  end
+end