alchemy-json_api 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89edfe1ba595351698467e746b9451be8483071b6e4878fd9ef30c6cd062011a
-  data.tar.gz: 5cdbc986b5eeae3dadfb7dd8f5beb6fc2632a5766131ac7b12e50b2595062e11
+  metadata.gz: 69488e287d0cb294483885e5b03deaebcf94a0905cd181613c84c6be90f4582f
+  data.tar.gz: 5fcffd69254524ab47f3f30b592633ce7ede6fc4312f02571297073655d3e2d1
 SHA512:
-  metadata.gz: 0cc256eb440f91369407d301410674cd7703a84bc28704e4ae220c32ee69d6cc6984f84bf53b6ec9d45c29b203381f30173292ef384b200aed95ab89aff96b12
-  data.tar.gz: e67fb531194df5b8b457f5cbdeadedd78e04cf5f2adfdb86ded3ec4a0eb8081e858bdff63a59b9f1a71ea81d87cae99e81526affcbb234985108d9b9d207b62b
+  metadata.gz: ef53c0124e8afd5eb85820362c5512be74a63659b1992b3aa43d22f884d9a5851fb1ae05722472b13873d3369c9ec475fa86de4329ec5b1c2d757271cf94032d
+  data.tar.gz: 3b7932b0e11841eabd4eeead158cdb54ac1484bd655629956354945383719e5f294736a7d74889b61c32a22f3f3befe19e1b3845abb9750b5c192e29ce453f53

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/app/serializers/alchemy/json_api/page_serializer.rb

@@ -15,7 +15,8 @@ module Alchemy
         :meta_keywords,
         :meta_description,
         :created_at,
-        :updated_at
+        :updated_at,
+        :restricted
       )
 
       cache_options store: Rails.cache, namespace: "alchemy-jsonapi"

data/lib/alchemy/json_api/version.rb

@@ -2,6 +2,6 @@
 
 module Alchemy
   module JsonApi
-    VERSION = "2.1.0"
+    VERSION = "2.3.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.3.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-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms