From 25b90a8724c8cc446d77d3d7311aa54cbdc10819 Mon Sep 17 00:00:00 2001 From: Leeingnyo Date: Sun, 15 Aug 2021 20:21:36 +0900 Subject: [PATCH 1/4] Apply cache on page, cover api Get image data and use it for hashing --- src/routes/api.cr | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/src/routes/api.cr b/src/routes/api.cr index a66210ae..f865a618 100644 --- a/src/routes/api.cr +++ b/src/routes/api.cr @@ -1,6 +1,7 @@ require "../mangadex/*" require "../upload" require "koa" +require "digest" struct APIRouter @@api_json : String? @@ -81,6 +82,7 @@ struct APIRouter tid = env.params.url["tid"] eid = env.params.url["eid"] page = env.params.url["page"].to_i + prev_e_tag = env.request.headers["If-None-Match"]? title = Library.default.get_title tid raise "Title ID `#{tid}` not found" if title.nil? @@ -90,7 +92,14 @@ struct APIRouter raise "Failed to load page #{page} of " \ "`#{title.title}/#{entry.title}`" if img.nil? - send_img env, img + e_tag = Digest::SHA1.hexdigest img.data + if prev_e_tag == e_tag + env.response.status_code = 304 + "" + else + env.response.headers["ETag"] = e_tag + send_img env, img + end rescue e Logger.error e env.response.status_code = 500 @@ -102,12 +111,14 @@ struct APIRouter Koa.path "tid", desc: "Title ID" Koa.path "eid", desc: "Entry ID" Koa.response 200, schema: Bytes, media_type: "image/*" + Koa.response 304, "" Koa.response 500, "Page not found or not readable" Koa.tag "library" get "/api/cover/:tid/:eid" do |env| begin tid = env.params.url["tid"] eid = env.params.url["eid"] + prev_e_tag = env.request.headers["If-None-Match"]? title = Library.default.get_title tid raise "Title ID `#{tid}` not found" if title.nil? @@ -118,7 +129,14 @@ struct APIRouter raise "Failed to get cover of `#{title.title}/#{entry.title}`" \ if img.nil? - send_img env, img + e_tag = Digest::SHA1.hexdigest img.data + if prev_e_tag == e_tag + env.response.status_code = 304 + "" + else + env.response.headers["ETag"] = e_tag + send_img env, img + end rescue e Logger.error e env.response.status_code = 500 From 2426ef05eca594c1a88b154b4d0d52a7713bc640 Mon Sep 17 00:00:00 2001 From: Leeingnyo Date: Sun, 15 Aug 2021 20:59:11 +0900 Subject: [PATCH 2/4] Apply cache on dimensions api Use zip_path and mtime for hashing It used for weak validation --- src/routes/api.cr | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/src/routes/api.cr b/src/routes/api.cr index f865a618..d854b1dd 100644 --- a/src/routes/api.cr +++ b/src/routes/api.cr @@ -649,21 +649,31 @@ struct APIRouter "height" => Int32, }], } + Koa.response 304 get "/api/dimensions/:tid/:eid" do |env| begin tid = env.params.url["tid"] eid = env.params.url["eid"] + prev_e_tag = env.request.headers["If-None-Match"]? title = Library.default.get_title tid raise "Title ID `#{tid}` not found" if title.nil? entry = title.get_entry eid raise "Entry ID `#{eid}` of `#{title.title}` not found" if entry.nil? - sizes = entry.page_dimensions - send_json env, { - "success" => true, - "dimensions" => sizes, - }.to_json + file_hash = Digest::SHA1.hexdigest (entry.zip_path + entry.mtime.to_s) + e_tag = "W/#{file_hash}" + if e_tag == prev_e_tag + env.response.status_code = 304 + "" + else + sizes = entry.page_dimensions + env.response.headers["ETag"] = e_tag + send_json env, { + "success" => true, + "dimensions" => sizes, + }.to_json + end rescue e Logger.error e send_json env, { From 31d425d462bfbe45c5559d0a964ba7eb2c185911 Mon Sep 17 00:00:00 2001 From: Alex Ling Date: Tue, 17 Aug 2021 07:14:24 +0000 Subject: [PATCH 3/4] Document the 304 responses --- src/routes/api.cr | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/routes/api.cr b/src/routes/api.cr index d854b1dd..d2e4d4f6 100644 --- a/src/routes/api.cr +++ b/src/routes/api.cr @@ -76,6 +76,7 @@ struct APIRouter Koa.path "page", schema: Int32, desc: "The page number to return (starts from 1)" Koa.response 200, schema: Bytes, media_type: "image/*" Koa.response 500, "Page not found or not readable" + Koa.response 304, "Page not modified (only available when `If-None-Match` is set)" Koa.tag "reader" get "/api/page/:tid/:eid/:page" do |env| begin @@ -111,7 +112,7 @@ struct APIRouter Koa.path "tid", desc: "Title ID" Koa.path "eid", desc: "Entry ID" Koa.response 200, schema: Bytes, media_type: "image/*" - Koa.response 304, "" + Koa.response 304, "Page not modified (only available when `If-None-Match` is set)" Koa.response 500, "Page not found or not readable" Koa.tag "library" get "/api/cover/:tid/:eid" do |env| @@ -649,7 +650,7 @@ struct APIRouter "height" => Int32, }], } - Koa.response 304 + Koa.response 304, "Not modified (only available when `If-None-Match` is set)" get "/api/dimensions/:tid/:eid" do |env| begin tid = env.params.url["tid"] From 4a261d5ff8cb61dfb0c288cbd75f5cf53e26bc7c Mon Sep 17 00:00:00 2001 From: Leeingnyo Date: Mon, 16 Aug 2021 00:55:54 +0900 Subject: [PATCH 4/4] Set Cache-Control header at page, dimensions API --- src/routes/api.cr | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/routes/api.cr b/src/routes/api.cr index d2e4d4f6..e04150b2 100644 --- a/src/routes/api.cr +++ b/src/routes/api.cr @@ -99,6 +99,7 @@ struct APIRouter "" else env.response.headers["ETag"] = e_tag + env.response.headers["Cache-Control"] = "public, max-age=86400" send_img env, img end rescue e @@ -670,6 +671,7 @@ struct APIRouter else sizes = entry.page_dimensions env.response.headers["ETag"] = e_tag + env.response.headers["Cache-Control"] = "public, max-age=86400" send_json env, { "success" => true, "dimensions" => sizes,