alchemy-json_api 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89edfe1ba595351698467e746b9451be8483071b6e4878fd9ef30c6cd062011a
-  data.tar.gz: 5cdbc986b5eeae3dadfb7dd8f5beb6fc2632a5766131ac7b12e50b2595062e11
+  metadata.gz: 998909ab79b771f8adf243e5aa3878116ff30b0292990676f2e3e66c9bcf7df4
+  data.tar.gz: 5981655e53fbd3af1d1d70260122db353b3f0cbf81622bb7ac2f891f6fcc3fdc
 SHA512:
-  metadata.gz: 0cc256eb440f91369407d301410674cd7703a84bc28704e4ae220c32ee69d6cc6984f84bf53b6ec9d45c29b203381f30173292ef384b200aed95ab89aff96b12
-  data.tar.gz: e67fb531194df5b8b457f5cbdeadedd78e04cf5f2adfdb86ded3ec4a0eb8081e858bdff63a59b9f1a71ea81d87cae99e81526affcbb234985108d9b9d207b62b
+  metadata.gz: 372fe15209e5eb39a767d40914cbe2bf77b4a7014e7db764bccf762206e019772d7fa9833fec19df80245b078acf2ee483e064829e37b824da613ff0dba68e6a
+  data.tar.gz: 3ee1be6b2024a95645d15aa4d98e6882fd356a31ca96263128a5ef9ac75aedd88679852816368f7988932550d906ac7fcdc5c821b51878c12f10cf096a222270

data/app/controllers/alchemy/json_api/admin/pages_controller.rb

@@ -25,7 +25,7 @@ module Alchemy
           end
         end
 
-        def last_modified_for(page)
+        def page_cache_key(page)
           page.updated_at
         end
 

data/app/controllers/alchemy/json_api/nodes_controller.rb

@@ -3,6 +3,8 @@
 module Alchemy
   module JsonApi
     class NodesController < JsonApi::BaseController
+      THREE_HOURS = 10800
+
       def index
         @nodes = node_scope.select(:id, :updated_at)
         if stale?(last_modified: @nodes.maximum(:updated_at), etag: @nodes)
@@ -17,7 +19,7 @@ module Alchemy
       private
 
       def cache_duration
-        ENV.fetch("ALCHEMY_JSON_API_CACHE_DURATION", 3).to_i.hours
+        ENV.fetch("ALCHEMY_JSON_API_CACHE_DURATION", THREE_HOURS).to_i
       end
 
       def jsonapi_meta(nodes)

data/app/controllers/alchemy/json_api/pages_controller.rb

@@ -3,6 +3,9 @@
 module Alchemy
   module JsonApi
     class PagesController < JsonApi::BaseController
+      THREE_HOURS = 10800
+      JSONAPI_STALEMAKERS = %i[include fields sort filter page]
+
       before_action :load_page_for_cache_key, only: :show
 
       def index
@@ -10,9 +13,10 @@ module Alchemy
 
         jsonapi_filter(page_scope, allowed) do |filtered_pages|
           @pages = filtered_pages.result
+
           if !@pages.all?(&:cache_page?)
             render_pages_json(allowed) && return
-          elsif stale?(last_modified: @pages.maximum(:published_at), etag: @pages.max_by(&:cache_key_with_version)&.cache_key_with_version)
+          elsif stale?(etag: etag(@pages))
             render_pages_json(allowed)
           end
         end
@@ -25,7 +29,7 @@ module Alchemy
           render(jsonapi: api_page(load_page)) && return
         end
 
-        if stale?(last_modified: last_modified_for(@page), etag: @page.cache_key_with_version)
+        if stale?(etag: etag(@page))
           # Only load page with all includes when browser cache is stale
           render jsonapi: api_page(load_page)
         end
@@ -47,7 +51,7 @@ module Alchemy
       end
 
       def cache_duration
-        ENV.fetch("ALCHEMY_JSON_API_CACHE_DURATION", 3).to_i.hours
+        ENV.fetch("ALCHEMY_JSON_API_CACHE_DURATION", THREE_HOURS).to_i
       end
 
       def caching_options
@@ -60,10 +64,6 @@ module Alchemy
           .or(page_scope.where(urlname: params[:path])).first!
       end
 
-      def last_modified_for(page)
-        page.published_at
-      end
-
       def jsonapi_meta(pages)
         pagination = jsonapi_pagination_meta(pages)
 
@@ -117,6 +117,17 @@ module Alchemy
         Alchemy::JsonApi::Page.new(page, page_version_type: page_version_type)
       end
 
+      def etag(pages)
+        pages = Array.wrap(pages)
+        return unless pages.any?
+        relevant_params = params.to_unsafe_hash.slice(*JSONAPI_STALEMAKERS).flatten.compact
+        pages.map { |page| page_cache_key(page) }.concat(relevant_params)
+      end
+
+      def page_cache_key(page)
+        page.cache_key_with_version
+      end
+
       def base_page_scope
         # cancancan is not able to merge our complex AR scopes for logged in users
         if can?(:edit_content, ::Alchemy::Page)

data/lib/alchemy/json_api/version.rb

@@ -2,6 +2,6 @@
 
 module Alchemy
   module JsonApi
-    VERSION = "2.1.0"
+    VERSION = "2.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Martin Meyerhoff
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms