alchemy-json_api 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3935cd3e895377d3abf8138b854c6aa54148da1a77d7fd7c9942b59a467117d9
-  data.tar.gz: 9c2c96ba95625c68e186558a5316eedf087d375784026d50ef93a7e4f2e4edec
+  metadata.gz: a4f9847b4b3ba3f36b06e079974f16b12a7469513edc62a819669da8acd05d9a
+  data.tar.gz: 9c3586a4aa8c5fb04aab2fd3bcfd9e535ef2e91b44fee242a8a2dd9e30ec92cc
 SHA512:
-  metadata.gz: fceba1d386c35489b4145a0becdffccdd4f00614546b15781038df613b5dea27d5dad7104ff00ad2920f52728ddb729f184d40b97542b36d96c2b05b0fb77216
-  data.tar.gz: f01bfc78e0d1911abf74666a4b8f19a6e0288d287125f0072364263c8450038b4bf6b8a808bdab65ed49c8265fdcdb9db2df883f60674707298e173144e11992
+  metadata.gz: 4a097ebe662c11540dda9e3233549fe471cb19c17694dc8ba74577e789ca949b86439a2b488461bfc8355041575f7a8c8527b024a9d7e45448c5a91ecadb37de
+  data.tar.gz: b8413c86022ec12c4193e8914ff2ad5c29fb0353409364eb445fbd78950d07c180a2c970138cf226eb40c328ac195fe1d8694b554cd1d5d0ead25841b6c3c4ae

data/Rakefile

@@ -20,6 +20,8 @@ task :test_setup do
     system <<-SETUP.strip_heredoc
       export RAILS_ENV=test && \
       bin/rake db:environment:set db:drop && \
+      bin/rake gutentag:install:migrations && \
+      bin/rails g gutentag:migration_versions && \
       bin/rake railties:install:migrations && \
       bin/rails g alchemy:devise:install --force && \
       bin/rake db:migrate

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

@@ -6,7 +6,7 @@ module Alchemy
         private
 
         def page_scope
-          page_scope_with_includes.layoutpages
+          base_page_scope.layoutpages
         end
       end
     end

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

@@ -4,9 +4,26 @@ module Alchemy
     module Admin
       class PagesController < JsonApi::PagesController
         prepend_before_action { authorize! :edit_content, Alchemy::Page }
+        before_action :set_current_preview, only: :show
 
         private
 
+        def cache_duration
+          0
+        end
+
+        def caching_options
+          { public: false, must_revalidate: true }
+        end
+
+        def set_current_preview
+          Alchemy::Page.current_preview = @page
+        end
+
+        def last_modified_for(page)
+          page.updated_at
+        end
+
         def page_version_type
           :draft_version
         end

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

@@ -5,7 +5,7 @@ module Alchemy
       private
 
       def page_scope
-        page_scope_with_includes.layoutpages
+        base_page_scope.layoutpages
       end
     end
   end

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

@@ -3,26 +3,57 @@
 module Alchemy
   module JsonApi
     class PagesController < JsonApi::BaseController
-      before_action :load_page, only: :show
+      before_action :load_page_for_cache_key, only: :show
 
       def index
-        allowed = [:page_layout]
-
-        jsonapi_filter(page_scope, allowed) do |filtered|
-          # decorate with our page model that has a eager loaded elements collection
-          pages = filtered.result.map { |page| api_page(page) }
-          jsonapi_paginate(pages) do |paginated|
-            render jsonapi: paginated
+        allowed = [:page_layout, :urlname]
+
+        jsonapi_filter(page_scope, allowed) do |filtered_pages|
+          @pages = filtered_pages.result
+          if stale?(last_modified: @pages.maximum(:published_at), etag: @pages.max_by(&:cache_key).cache_key)
+            # Only load pages with all includes when browser cache is stale
+            jsonapi_filter(page_scope_with_includes, allowed) do |filtered|
+              # decorate with our page model that has a eager loaded elements collection
+              filtered_pages = filtered.result.map { |page| api_page(page) }
+              jsonapi_paginate(filtered_pages) do |paginated|
+                render jsonapi: paginated
+              end
+            end
           end
         end
+
+        expires_in cache_duration, { public: @pages.none?(&:restricted?) }.merge(caching_options)
       end
 
       def show
-        render jsonapi: api_page(@page)
+        if stale?(last_modified: last_modified_for(@page), etag: @page.cache_key)
+          # Only load page with all includes when browser cache is stale
+          render jsonapi: api_page(load_page)
+        end
+
+        expires_in cache_duration, { public: !@page.restricted? }.merge(caching_options)
       end
 
       private
 
+      def cache_duration
+        ENV.fetch("ALCHEMY_JSON_API_CACHE_DURATION", 3).to_i.hours
+      end
+
+      def caching_options
+        { must_revalidate: true }
+      end
+
+      # Get page w/o includes to get cache key
+      def load_page_for_cache_key
+        @page = page_scope.where(id: params[:path]).
+          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)
 
@@ -38,20 +69,19 @@ module Alchemy
 
       def load_page_by_id
         return unless params[:path] =~ /\A\d+\z/
-        page_scope.find_by(id: params[:path])
+        page_scope_with_includes.find_by(id: params[:path])
       end
 
       def load_page_by_urlname
-        page_scope.find_by(urlname: params[:path])
+        page_scope_with_includes.find_by(urlname: params[:path])
       end
 
       def page_scope
-        page_scope_with_includes.contentpages
+        base_page_scope.contentpages
       end
 
       def page_scope_with_includes
-        base_page_scope.
-          where(language: Language.current).
+        page_scope.
           includes(
             [
               :legacy_urls,
@@ -80,9 +110,9 @@ module Alchemy
       def base_page_scope
         # cancancan is not able to merge our complex AR scopes for logged in users
         if can?(:edit_content, ::Alchemy::Page)
-          Alchemy::Page.all.joins(page_version_type)
+          Alchemy::Language.current.pages.joins(page_version_type)
         else
-          Alchemy::Page.published.joins(page_version_type)
+          Alchemy::Language.current.pages.published.joins(page_version_type)
         end
       end
 

data/app/serializers/alchemy/json_api/element_serializer.rb

@@ -12,6 +12,8 @@ module Alchemy
         :updated_at,
       )
 
+      cache_options store: Rails.cache, namespace: "alchemy-jsonapi"
+
       attribute :deprecated do |element|
         !!element.definition[:deprecated]
       end

data/app/serializers/alchemy/json_api/page_serializer.rb

@@ -18,6 +18,8 @@ module Alchemy
         :updated_at,
       )
 
+      cache_options store: Rails.cache, namespace: "alchemy-jsonapi"
+
       attribute :legacy_urls do |page|
         page.legacy_urls.map(&:urlname)
       end

data/lib/alchemy/json_api/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Alchemy
   module JsonApi
-    VERSION = "0.20.0"
+    VERSION = "0.21.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-json_api
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Martin Meyerhoff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -175,7 +175,7 @@ homepage: https://github.com/AlchemyCMS/alchemy-json_api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,8 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.26
+signing_key:
 specification_version: 4
 summary: A JSONAPI compliant API for AlchemyCMS
 test_files: []