seo_cache 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7286c3adfbf791c5b7091e4f689e4fbfe69bef35973e01c3f50f4d2fa3c8b9bb
-  data.tar.gz: 4b27b16b60243f1f428ad36aa6e00d9699d1e71afe42100c1e643ed56b06ba4a
+  metadata.gz: 612bb7e5cfe82ac49b35bc86915082f054c9e4dbe91bc2b664038de965d1f07e
+  data.tar.gz: ca1dcfcff1cfa0fb9bcf8dc4ec6d3edc0660c2965fc9c9276c01581638271a27
 SHA512:
-  metadata.gz: 66ab72c0aea1d7029ebd8f39e90b8aa5b36e8d15951b0359824989175e56098d380882fe0e05c8a90e9faa1fbf4b43d2a9acd53ec9aea67aebf3ed87399858d2
-  data.tar.gz: 60121490b30d93c0fcd204f3dcf5c06bf3c9a14aa5e76eb19a9cf9986ff119bfb72b6e6ead3a119f33479334eeb5e8831b99bf68f56c7ad54ad44bfd20741eb8
+  metadata.gz: 69904412e9083c552ae777c266b960e0d5295fc3536d4f85da90ad47bcb77349e2a6c53be9e4dc9eb0ee8602dc121841974205e1480a15347ed5798a8c781bd9
+  data.tar.gz: 205c8bc45ac28e7969342b5a495530557a1020762969c7fed49cea7bc3bbdf8126fe02866d8eef4f43267753886ee51ac1080aded6e50df4ed8ae946234f2ec3

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.2.1
+
+- Update deprecated Selenium options
+
+## 1.2.0
+
+- Do not try to cache invalid requests
+
+## 1.1.2
+
+- Correct populate seo cache method
+
+## 1.1.1
+
+- Add new option to use locale as first directory for cache path
+
 ## 1.1.0
 
 - Update dependencies

data/lib/seo_cache/middleware.rb

@@ -16,52 +16,39 @@ module SeoCache
     end
 
     def call(env)
-      if prerender_page?(env)
+      @status, @headers, @response = @app.call(env)
+
+      if prerender_page?(env, @status)
         cached_response = before_render(env)
 
         return cached_response.finish if cached_response.present?
 
-        if SeoCache.log_missed_cache
-          env_request = Rack::Request.new(env)
-          SeoCache.log("missed cache : #{env_request.path} (User agent: #{env_request.user_agent})")
-        end
-
         if SeoCache.prerender_service_url.present?
           prerender_response = prerender_service(env)
           if prerender_response
             response = build_response_from_prerender(prerender_response.body)
             after_render(env, prerender_response)
+
             return response.finish
           end
         else
           Thread.new do
             prerender_data = page_render(env)
-            # Extract status from render page or return success (200)
-            status = prerender_data&.scan(/<!--status:(\d+)-->/)&.last&.first || 200
-
-            if SeoCache.log_missed_cache && status.to_s.start_with?('2')
-              env_request = Rack::Request.new(env)
-              SeoCache.log("missed cache : #{env_request.path} (User agent: #{env_request.user_agent})")
-            end
 
-            after_render(env, prerender_data, status)
+            after_render(env, prerender_data, @status)
           end
         end
       elsif prerender_params?(env)
-        env['seo_mode'] = true
-        # Add status to render page because Selenium doesn't return http headers or status...
+        env['seo_mode']           = true
         status, headers, response = @app.call(env)
-        status_code               = "<!--status:#{status}-->"
-        # Cannot add at the top of file, Chrome removes leading comments...
         begin
-          body_code = response.body.sub(/<head( ?)(.*?)>/i, "<head\\1\\2>#{status_code}")
-          return [status, headers, [body_code]]
+          return [status, headers, [response.body]]
         rescue
           return [status, headers, [nil]]
         end
       end
 
-      return @app.call(env)
+      return [@status, @headers, @response]
     end
 
     def prerender_params?(env)
@@ -75,13 +62,15 @@ module SeoCache
       return true if query_params.has_key?(SeoCache.prerender_url_param) || query_params.has_key?(SeoCache.force_cache_url_param)
     end
 
-    def prerender_page?(env)
+    def prerender_page?(env, status)
       user_agent                   = env['HTTP_USER_AGENT']
       buffer_agent                 = env['HTTP_X_BUFFERBOT']
       is_requesting_prerender_page = false
 
       return false unless user_agent
 
+      return false if status.to_i > 299
+
       return false if env['REQUEST_METHOD'] != 'GET'
 
       request      = Rack::Request.new(env)
@@ -186,7 +175,9 @@ module SeoCache
       # return nil unless @options[:before_render]
       # cached_render = @options[:before_render].call(env)
 
-      cached_render = @page_caching.get(Rack::Request.new(env).path)
+      env_request = Rack::Request.new(env)
+
+      cached_render = @page_caching.get(env_request.path, get_locale(env_request.params, env_request.host))
 
       return nil unless cached_render
 
@@ -213,12 +204,21 @@ module SeoCache
     def after_render(env, response, status = 200)
       return unless response && SeoCache.cache_only_status.include?(status.to_i)
 
+      env_request = Rack::Request.new(env)
+
       if SeoCache.log_missed_cache
-        env_request = Rack::Request.new(env)
         SeoCache.log("missed cache : #{env_request.path} (User agent: #{env_request.user_agent})")
       end
 
-      @page_caching.cache(response, Rack::Request.new(env).path)
+      @page_caching.cache(response, env_request.path, get_locale(env_request.params, env_request.host))
+    end
+
+    def get_locale(params, host)
+      if SeoCache.locale_as_first_directory
+        SeoCache.locale_method ? SeoCache.locale_method.call(params, host) : I18n.locale
+      else
+        nil
+      end
     end
   end
 end

data/lib/seo_cache/page_caching.rb

@@ -13,31 +13,31 @@ module SeoCache
       @redis = Redis::Namespace.new(SeoCache.redis_namespace, redis: Redis.new(host: uri.host, port: uri.port, password: uri.password, connect_timeout: 1, timeout: 1), warnings: false)
     end
 
-    def get(path, extension = nil)
-      @redis.get(cache_path(path, extension)) if SeoCache.memory_cache? && @redis
+    def get(path, locale_domain = nil, extension = nil)
+      @redis.get(cache_path(path, locale_domain, extension)) if SeoCache.memory_cache? && @redis
     end
 
     def cache(content, path, locale_domain = nil, extension = nil, gzip = Zlib::BEST_COMPRESSION)
       instrument :write_page, path do
         if SeoCache.memory_cache? && @redis
-          write_to_memory(content, cache_path(path, extension, locale_domain))
+          write_to_memory(content, cache_path(path, locale_domain, extension))
         else
-          write_to_disk(content, cache_path(path, extension, locale_domain), gzip)
+          write_to_disk(content, cache_path(path, locale_domain, extension), gzip)
         end
       end
     end
 
-    def expire(path)
+    def expire(path, locale_domain = nil, extension = nil)
       instrument :expire_page, path do
-        delete(cache_path(path))
+        delete(cache_path(path, locale_domain, extension))
       end
     end
 
-    def cache_exists?(path)
+    def cache_exists?(path, locale_domain = nil, extension = nil)
       if SeoCache.memory_cache? && @redis
-        @redis.exists?(cache_path(path))
+        @redis.exists?(cache_path(path, locale_domain, extension))
       else
-        File.exist?(cache_path(path))
+        File.exist?(cache_path(path, locale_domain, extension))
       end
     end
 
@@ -51,7 +51,7 @@ module SeoCache
       SeoCache.cache_extension
     end
 
-    def cache_file(path, extension, locale_domain)
+    def cache_file(path, locale_domain, extension)
       name = if path.empty? || path =~ %r{\A/+\z}
                '/index'
              else
@@ -65,8 +65,8 @@ module SeoCache
       name
     end
 
-    def cache_path(path, extension = nil, locale_domain = nil)
-      File.join(cache_directory, cache_file(path, extension, locale_domain))
+    def cache_path(path, locale_domain = nil, extension = nil)
+      File.join(cache_directory, cache_file(path, locale_domain, extension))
     end
 
     def write_to_memory(content, path)

data/lib/seo_cache/page_render.rb

@@ -33,21 +33,14 @@ module SeoCache
 
       Selenium::WebDriver::Chrome.path = SeoCache.chrome_path if SeoCache.chrome_path
 
-      browser_options = ::Selenium::WebDriver::Chrome::Options.new
-      browser_options.args << 'disable-infobars'
-      browser_options.args << '--headless'
-      browser_options.args << '--no-sandbox'
-      browser_options.args << '--incognito'
-      browser_options.args << '--disable-dev-shm-usage'
-      browser_options.args << '--disable-gpu'
-      browser_options.args << '--disable-web-security'
-      browser_options.args << '--disable-extensions'
-      browser_options.args << '--disable-logging'
-      browser_options.args << '--disable-notifications'
-      browser_options.args << '--disable-sync'
-      browser_options.args << '--window-size=1920x1080'
-      browser_options.args << "--remote-debugging-port=#{SeoCache.chrome_debugging_port}" if SeoCache.chrome_debugging_port
-      @driver = ::Selenium::WebDriver.for(:chrome, options: browser_options)
+      browser_options = %w[headless incognito disable-gpu disable-infobars disable-dev-shm-usage disable-gpu disable-web-security disable-extensions no-sandbox disable-logging disable-notifications disable-sync window-size=1920x1080]
+      browser_options << "remote-debugging-port=#{SeoCache.chrome_debugging_port}" if SeoCache.chrome_debugging_port
+      @driver = ::Selenium::WebDriver.for(
+        :chrome,
+        capabilities: [Selenium::WebDriver::Chrome::Options.new(
+          args: browser_options
+        )]
+      )
     end
   end
 end

data/lib/seo_cache/populate_cache.rb

@@ -35,7 +35,7 @@ module SeoCache
     private
 
     def generate_cache(path, locale_domain = nil)
-      return if @page_caching.cache_exists?(path) && !@force_cache
+      return if @page_caching.cache_exists?(path, locale_domain) && !@force_cache
 
       url = @host + path
       url += path.include?('?') ? '&' : '?'

data/lib/seo_cache/version.rb

@@ -1,3 +1,3 @@
 module SeoCache
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.1'.freeze
 end

data/lib/seo_cache.rb

@@ -22,6 +22,12 @@ module SeoCache
   mattr_accessor :cache_path
   self.cache_path = ''
 
+  mattr_accessor :locale_as_first_directory
+  self.locale_as_first_directory = false
+
+  mattr_accessor :locale_method
+  self.locale_method = nil
+
   mattr_accessor :cache_extension
   self.cache_extension = '.html'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seo_cache
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - FloXcoder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Cache dedicated for SEO with Javascript rendering