tp_common 0.4.2 → 0.4.3.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c82f0ce642dc1cd99e759a8afa0fd7ef2ab84dfb63ee3e4907c27f28130ecf0
-  data.tar.gz: 2af83acd05b645bc50f37808f6d8dbcb046da87f211b55bbec2c3bd4d69be9f3
+  metadata.gz: 025ffd9b6a300dba51d4e8edbae4a778d300835fa674ec52bcbca3a819d072c9
+  data.tar.gz: 651838404deaf1632f71078813c04b5e0f4486946471be743b9dfdf277669009
 SHA512:
-  metadata.gz: e79880322a5417851ad894fb64e44fe64a65de46da4d89253d6be0ba092fead386cbed9655ada94bcd246decfe456bea4ad78f9d78e007ff52ccceb8d9390391
-  data.tar.gz: 502054409c6606ced1ce284b798326451642505154bb329eb42f573682eb66a2d08036a0633e8c9825794e0154cba734046fc9f68c7064b582f9f3feff4f4b6d
+  metadata.gz: d0c929022ae62ef0e961548e79572e64fe1e9a6c01161b14b262e6316e1919b9f24653bb18cf4a10f2461f74ea1ad9550270833306909216afcf6c76ee170039
+  data.tar.gz: 752c51e003424ab2ca708bd617fd39c1d57987e19d71733e63046e54e5dc3a3cb3b3b56401da7e68602f3cc2d9369534310bd895ed7bfbf81779c18d5d19263c

data/gemfiles/rails_4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    tp_common (0.4.2)
+    tp_common (0.4.3.pre1)
       activesupport (>= 4.2.0, <= 5.2.1)
       aws-sdk-s3 (~> 1.19)
       fog-aws (~> 2.0)
@@ -51,8 +51,8 @@ GEM
       thor (>= 0.14.0)
     arel (6.0.4)
     aws-eventstream (1.0.1)
-    aws-partitions (1.136.0)
-    aws-sdk-core (3.46.0)
+    aws-partitions (1.140.0)
+    aws-sdk-core (3.46.2)
       aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)

data/gemfiles/rails_5.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    tp_common (0.4.2)
+    tp_common (0.4.3.pre1)
       activesupport (>= 4.2.0, <= 5.2.1)
       aws-sdk-s3 (~> 1.19)
       fog-aws (~> 2.0)
@@ -54,8 +54,8 @@ GEM
       thor (>= 0.14.0)
     arel (7.1.4)
     aws-eventstream (1.0.1)
-    aws-partitions (1.136.0)
-    aws-sdk-core (3.46.0)
+    aws-partitions (1.140.0)
+    aws-sdk-core (3.46.2)
       aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)

data/gemfiles/rails_latest.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    tp_common (0.4.2)
+    tp_common (0.4.3.pre1)
       activesupport (>= 4.2.0, <= 5.2.1)
       aws-sdk-s3 (~> 1.19)
       fog-aws (~> 2.0)
@@ -58,8 +58,8 @@ GEM
       thor (>= 0.14.0)
     arel (9.0.0)
     aws-eventstream (1.0.1)
-    aws-partitions (1.136.0)
-    aws-sdk-core (3.46.0)
+    aws-partitions (1.140.0)
+    aws-sdk-core (3.46.2)
       aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)

data/lib/tp_common.rb

@@ -17,5 +17,6 @@ end
 require "tp_common/timezones"
 require "tp_common/timezones/zone"
 require "tp_common/assets_loader"
+require "tp_common/asset_loaders/remote_assets_loader"
 require "tp_common/file_storage"
 require "tp_common/app_config"

data/lib/tp_common/asset_loaders/errors.rb

@@ -0,0 +1,8 @@
+module TpCommon
+  module AssetLoaders
+    module Errors
+      class AssetNotFound < ::StandardError; end
+      class PackageIsNotLoaded < ::StandardError; end
+    end
+  end
+end

data/lib/tp_common/asset_loaders/package_path_providers/development.rb

@@ -0,0 +1,38 @@
+require 'net/http'
+
+module TpCommon
+  module AssetLoaders
+    module PackagePathProviders
+      class Development < Production
+        DEVELOPMENT_CDN = 'http://localhost:3001'
+
+        def asset_url(package_name, version, asset)
+          @development ||= head("#{DEVELOPMENT_CDN}/_ping")
+          if @development
+            return "#{cdn(package_name, version)}/#{asset}"
+          end
+
+          super(package_name, version, asset)
+        end
+
+        private
+
+        def head(url_string)
+          url = URI.parse(url_string)
+          req = Net::HTTP.new(url.host, url.port)
+          req.use_ssl = (url.scheme == 'https')
+
+          path = url.path unless url.path.nil?
+
+          res = begin
+                  req.request_head(path || '/')
+                rescue StandardError
+                  nil
+                end
+
+          res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
+        end
+      end
+    end
+  end
+end

data/lib/tp_common/asset_loaders/package_path_providers/production.rb

@@ -0,0 +1,15 @@
+module TpCommon
+  module AssetLoaders
+    module PackagePathProviders
+      class Production
+        def initialize(default_cdn)
+          @default_cdn = default_cdn
+        end
+
+        def asset_url(package_name, version, asset)
+          "#{cdn(package_name, version)}/#{asset.to_s.split('.').insert(-2, 'min').join('.')}"
+        end
+      end
+    end
+  end
+end

data/lib/tp_common/asset_loaders/remote_assets_loader.rb

@@ -0,0 +1,115 @@
+require 'tp_common/asset_loaders/errors'
+require 'tp_common/asset_loaders/package_path_providers/production'
+TpCommon::AssetLoaders::ProviderClass = if defined?(Rails) && (Rails.env.development? || Rails.env.test?)
+  require 'tp_common/asset_loaders/package_path_providers/development'
+  TpCommon::AssetLoaders::PackagePathProviders::Development
+else
+  TpCommon::AssetLoaders::PackagePathProviders::Production
+end
+
+module TpCommon
+  module AssetLoaders
+    # This class supports switching between development env and production env in loading assets
+    # Follow TINYpulse development convention.
+    # - Use minified assets on cdn for production
+    # - On development, prefer development spa on local, if not, fallback to production behaviors
+    #
+    # To config:
+    # ```
+    # TpCommon::AssetLoaders::RemoteAssetsLoader.configure do |config|
+    #   config.cdn = 'https://other.hotter.cdn'
+    # end
+    # # Load a package. This is required.
+    # TpCommon::AssetLoaders::RemoteAssetsLoader.load(:'any-spa', 'v1.0.0')
+    # ```
+    #
+    # Use in template:
+    # ```
+    # <%= javascript_include_tag TpCommon::AssetLoaders::RemoteAssetsLoader[:'any-spa']['main.js'] %>
+    # ```
+    class RemoteAssetsLoader
+      DEFAULT_CDN = 'https://cdn.tinypulse.com/spa'
+      LoaderConfiguration = Struct.new(:cdn, :package_path_provider)
+
+      class << self
+        # Configure RemoteAssetsLoader, for now, only :cdn is supported
+        # ```
+        #   TpCommon::AssetLoaders::RemoteAssetsLoader.configure do |config|
+        #     config.cdn = 'https://other.hotter.cdn'
+        #   end
+        # ```
+        def configure
+          yield(config)
+
+          config.package_path_provider = TpCommon::AssetLoaders::ProviderClass.new(config.cdn)
+        end
+
+        # Load a package (SPA) with specific version to use.
+        # ```
+        #   TpCommon::AssetLoaders::RemoteAssetsLoader.load(:'tinypulse-spa-1', 'v1.0.0')
+        # ```
+        #
+        # To prioritize version from env variable, we dont provide this magic here
+        # So declare it explicitly when load:
+        # ```
+        #   TpCommon::AssetLoaders::RemoteAssetsLoader.load(:'tinypulse-spa-1', ENV['SPA_VERSION_TINYPULSE_SPA_1_HOT_CHANGE'] || 'v1.0.0')
+        # ```
+        def load(package_name, version)
+          package_name = package_name.to_sym
+          packages[package_name] = new(package_name, version)
+          packages
+        end
+
+        # Get package:
+        # ```
+        #   TpCommon::AssetLoaders::RemoteAssetsLoader[:'tinypulse-spa-1'][:'main.js'] # 'https://some.cdn/spa/tinypulse-spa-1/v1.0.0/main.js'
+        # ```
+        # Raise `PackageIsNotLoaded` exception if package is not found.
+        #
+        # - In Rails development environment, Asset loader will try to ping and access assets at localhost:3001
+        #     Which assets are served without minified, so file name is keep the same.
+        # - In other environments, assets are minified and served through cdn
+        #     File name will be append `.min` before extension. i.e. 'main.min.js'
+        #
+        def [](package_name)
+          packages[package_name].tap do |package|
+            raise TpCommon::AssetLoaders::Errors::PackageIsNotLoaded.new("Package #{package_name} is not loaded yet.") if package.nil?
+          end
+        end
+
+        def asset_url(package_name, version, asset)
+          config.package_path_provider.asset_url(package_name, version, asset)
+        end
+
+        private
+
+        def new_config
+          LoaderConfiguration.new(DEFAULT_CDN, nil)
+        end
+
+        def config
+          @config ||= new_config
+        end
+
+        def packages
+          @packages ||= {}
+        end
+      end
+
+      def initialize(package_name, version)
+        @package_name = package_name
+        @version = version
+
+        @cached_assets = Hash.new { |hash, key| hash[key] = RemoteAssetsLoader.asset_url(@package_name, @version, key.to_s) }
+      end
+
+      def [](asset_name)
+        # TODO: [AV] Do performance test and cache the string in system level
+        # NOTE: [AV] It's secure to check this asset url exists by Net::HTTP then try more than 1 cdn.
+        #       but DONT DO IT. Using unavailable spa version/cdn is a SERIOUS problem need to solve, not auto-recovery
+        #       beside, this url will be called every page hit, so any milisecond are counted.
+        @cached_assets[asset_name]
+      end
+    end
+  end
+end

data/lib/tp_common/version.rb

@@ -1,3 +1,3 @@
 module TpCommon
-  VERSION = "0.4.2"
+  VERSION = "0.4.3.pre1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tp_common
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3.pre1
 platform: ruby
 authors:
 - TINYpulse Devops
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-01 00:00:00.000000000 Z
+date: 2019-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -212,6 +212,10 @@ files:
 - lib/tp_common.rb
 - lib/tp_common/app_config.rb
 - lib/tp_common/app_config/environment.rb
+- lib/tp_common/asset_loaders/errors.rb
+- lib/tp_common/asset_loaders/package_path_providers/development.rb
+- lib/tp_common/asset_loaders/package_path_providers/production.rb
+- lib/tp_common/asset_loaders/remote_assets_loader.rb
 - lib/tp_common/assets_loader.rb
 - lib/tp_common/file_storage.rb
 - lib/tp_common/file_storage/base.rb
@@ -247,9 +251,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.2
 signing_key: