I have a question regarding fragment caching in the context of an API that uses versioncake.
It seems natural that request_version is taken into account when computing hash digests but since I could not find confirmation in the docs, I've pondered whether I should be using request_version for each cache key computation.
As I'm not too familiar with ActionView or Version Cake internals, many thanks in advance for confirmation (or refutation!) of my assumption. 🙂
––––––––––––––
_To illustrate my post, here is an example reflecting what's happening in my development logs. It that particular case, everything looks fine: for each "apiversion", different keys are set in Redis regardless of the level of nesting for partials that might exist in different versions.
Of course, feel free to take inspiration from it if you feel it could be a useful addition to the README. 🙂
Main Template
json.id @shop.id
json.name @shop.name
json.product_categories do
json.array! @product_categories do |category|
json.cache! category do
json.partial!("product_categories/product_category", product_category: category)
end
options = {
expires_in: 10.minutes,
key: proc { |product| [product.cache_key] },
}
json.products do
json.cache_collection!(category.products, options) do |product|
# With "products/_product" being:
#
# json.id product.id
# json.name product.name
#
# json.properties do
# json.partial!("products/properties", properties: product.properties)
# end
json.partial!("products/product", product: product)
end
end
end
end
Files
# Main template
app/views/shops/show.json.v1.jbuilder
# Partials to cache
app/views/product_categories/_product_category.json.v1.jbuilder
app/views/products/_product.json.v1.jbuilder
app/views/products/_properties.json.v1.jbuilder
Hello,
I have a question regarding fragment caching in the context of an API that uses versioncake.
It seems natural that
request_versionis taken into account when computing hash digests but since I could not find confirmation in the docs, I've pondered whether I should be usingrequest_versionfor each cache key computation.As I'm not too familiar with ActionView or Version Cake internals, many thanks in advance for confirmation (or refutation!) of my assumption. 🙂
––––––––––––––
_To illustrate my post, here is an example reflecting what's happening in my development logs. It that particular case, everything looks fine: for each "apiversion", different keys are set in Redis regardless of the level of nesting for partials that might exist in different versions.
Of course, feel free to take inspiration from it if you feel it could be a useful addition to the README. 🙂
Main Template
Files
Redis logs on fragment writes/reads
1. additional v2 partial:
_product_category.json.v2.jbuildercall the endpoint with the Accept header "api_version=1"
1. writes
2. reads (OK, same as writes)
call the endpoint with the Accept header "api_version=2"
1. writes
2. reads (OK, same as writes)
2. additional v2 partial:
_product.json.v2.jbuildercall the endpoint with the Accept header "api_version=1"
1. writes
2. reads (OK, same as writes)
call the endpoint with the Accept header "api_version=2"
1. writes
2. reads (OK, same as writes)
3. additional v2 partial:
_properties.json.v2.jbuildercall the endpoint with the Accept header "api_version=1"
1. writes
2. reads (OK, same as writes)
call the endpoint with the Accept header "api_version=2"
1. writes
2. reads (OK, same as writes)