macaw_framework 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17a2ff330e9f546997fcbbcbbc8bc0e08af19c08980056999b60f3307aaf898d
-  data.tar.gz: 2af901040509fcd7feecaa5bc9cc762967f9530cd6277b6fc0d4ac1fe5a3bb20
+  metadata.gz: fd7f1b0bfc6306d0d86f2228f3a51cf955cad0db12031920cf9f0f131d664f6d
+  data.tar.gz: 92ea7a2854218fb31726c37bc6cbe99399159cdb0cc08a3c72ce62e4b27e72c2
 SHA512:
-  metadata.gz: 07127b57e24d02a95a9bc444bc444bb3ce44d9f80c6fc9f08b5155c88a3355bd20ee93ae5831f028596b114a4cb200c31bd5247bff8ba043d65f844c426a6bd7
-  data.tar.gz: 4ca1a0f63ea1feb4de1b712f63b786286b791bc9df255011b4ef7acf5a740076c65821b13311bf5c3741bfde945ba0f83dae8ad0073bb56dab6962295b1dc7b5
+  metadata.gz: 1a06342e79d24109aa1b47058e7a973009e9e19a0a898f95c653a13dd3558b5576be34b628f5fbf488aa0b019f35ed6f941fd1b3808c7894bac9dd1b9d9c85e5
+  data.tar.gz: cfff2868edfd0314006a36cdeb21d1f69ed6388b2c9a5181cec7f67c1c101818f6feb58e865d3672c84b55c3d71372a3850e9dd6b0ee6f3f948baec5af2a726c

data/CHANGELOG.md

@@ -128,3 +128,7 @@
 
 - Fixing small bug on lof during endpoint declaration
 - Disclosing security issue on session storage
+
+## [1.2.5]
+
+- Improvements to cache usability

data/README.md

@@ -104,7 +104,7 @@ m.start!
 ### Caching: Improve performance by caching responses and configuring cache invalidation
 
 ```ruby
-m.get('/cached_data', cache: true) do |context|
+m.get('/cached_data', cache: ["header_to_cache", "query_param_to_cache"]) do |context|
   # Retrieve data
 end
 ```
@@ -140,11 +140,7 @@ end
     "bind": "localhost",
     "threads": 200,
     "cache": {
-      "cache_invalidation": 3600,
-      "ignore_headers": [
-        "header-to-be-ignored-from-caching-strategy",
-        "another-header-to-be-ignored-from-caching-strategy"
-      ]
+      "cache_invalidation": 3600
     },
     "prometheus": {
       "endpoint": "/metrics"

data/lib/macaw_framework/aspects/cache_aspect.rb

@@ -6,7 +6,7 @@ module CacheAspect
   def call_endpoint(cache, *args)
     return super(*args) unless !cache[:cache].nil? && cache[:endpoints_to_cache]&.include?(args[0])
 
-    cache_filtered_name = cache_name_filter(args[1], cache[:ignored_headers])
+    cache_filtered_name = cache_name_filter(args[1], cache[:cached_methods][args[0]])
 
     cache[:cache].mutex.synchronize do
       return cache[:cache].cache[cache_filtered_name][0] unless cache[:cache].cache[cache_filtered_name].nil?
@@ -19,9 +19,10 @@ module CacheAspect
 
   private
 
-  def cache_name_filter(client_data, ignored_headers)
-    filtered_headers = client_data[:headers].filter { |key, _value| !ignored_headers&.include?(key) }
-    [{ body: client_data[:body], params: client_data[:params], headers: filtered_headers }].to_s.to_sym
+  def cache_name_filter(client_data, cached_methods_params)
+    filtered_headers = client_data[:headers]&.filter { |key, _value| cached_methods_params&.include?(key) }
+    filtered_params = client_data[:params]&.filter { |key, _value| cached_methods_params&.include?(key) }
+    [{ params: filtered_params, headers: filtered_headers }].to_s.to_sym
   end
 
   def should_cache_response?(status)

data/lib/macaw_framework/core/common/server_base.rb

@@ -83,12 +83,6 @@ module ServerBase
     )
   end
 
-  def set_cache_ignored_h
-    return unless @macaw.config&.dig("macaw", "cache", "ignore_headers")
-
-    @macaw.config["macaw"]["cache"]["ignore_headers"] || []
-  end
-
   def set_ssl
     ssl_config = @macaw.config["macaw"]["ssl"] if @macaw.config&.dig("macaw", "ssl")
     ssl_config ||= nil

data/lib/macaw_framework/core/thread_server.rb

@@ -32,11 +32,13 @@ class ThreadServer
     @macaw_log = macaw.macaw_log
     @num_threads = macaw.threads
     @work_queue = Queue.new
-    ignored_headers = set_cache_ignored_h
     set_features
     @rate_limit ||= nil
-    ignored_headers ||= nil
-    @cache = { cache: cache, endpoints_to_cache: endpoints_to_cache || [], ignored_headers: ignored_headers }
+    @cache = {
+      cache: cache,
+      endpoints_to_cache: endpoints_to_cache || [],
+      cached_methods: macaw.cached_methods
+    }
     @prometheus = prometheus
     @prometheus_middleware = prometheus_mw
     @workers = []

data/lib/macaw_framework/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MacawFramework
-  VERSION = "1.2.4"
+  VERSION = "1.2.5"
 end

data/lib/macaw_framework.rb

@@ -19,16 +19,18 @@ module MacawFramework
   # Class responsible for creating endpoints and
   # starting the web server.
   class Macaw
-    ##
-    # Array containing the routes defined in the application
-    attr_reader :routes, :macaw_log, :config, :jobs
+    attr_reader :routes, :macaw_log, :config, :jobs, :cached_methods
     attr_accessor :port, :bind, :threads
 
     ##
+    # Initialize Macaw Class
     # @param {Logger} custom_log
+    # @param {ThreadServer} server
+    # @param {String?} dir
     def initialize(custom_log: Logger.new($stdout), server: ThreadServer, dir: nil)
       begin
         @routes = []
+        @cached_methods = {}
         @macaw_log ||= custom_log
         @config = JSON.parse(File.read("application.json"))
         @port = @config["macaw"]["port"] || 8080
@@ -65,7 +67,7 @@ module MacawFramework
     # macaw.get("/hello") do |context|
     #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
     # end
-    def get(path, cache: false, &block)
+    def get(path, cache: [], &block)
       map_new_endpoint("get", cache, path, &block)
     end
 
@@ -81,7 +83,7 @@ module MacawFramework
     # macaw.post("/hello") do |context|
     #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
     # end
-    def post(path, cache: false, &block)
+    def post(path, cache: [], &block)
       map_new_endpoint("post", cache, path, &block)
     end
 
@@ -96,7 +98,7 @@ module MacawFramework
     # macaw.put("/hello") do |context|
     #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
     # end
-    def put(path, cache: false, &block)
+    def put(path, cache: [], &block)
       map_new_endpoint("put", cache, path, &block)
     end
 
@@ -111,7 +113,7 @@ module MacawFramework
     # macaw.patch("/hello") do |context|
     #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
     # end
-    def patch(path, cache: false, &block)
+    def patch(path, cache: [], &block)
       map_new_endpoint("patch", cache, path, &block)
     end
 
@@ -126,7 +128,7 @@ module MacawFramework
     # macaw.delete("/hello") do |context|
     #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
     # end
-    def delete(path, cache: false, &block)
+    def delete(path, cache: [], &block)
       map_new_endpoint("delete", cache, path, &block)
     end
 
@@ -196,7 +198,8 @@ module MacawFramework
     end
 
     def map_new_endpoint(prefix, cache, path, &block)
-      @endpoints_to_cache << "#{prefix}.#{RequestDataFiltering.sanitize_method_name(path)}" if cache
+      @endpoints_to_cache << "#{prefix}.#{RequestDataFiltering.sanitize_method_name(path)}" unless cache.empty?
+      @cached_methods["#{prefix}.#{RequestDataFiltering.sanitize_method_name(path)}"] = cache unless cache.empty?
       path_clean = RequestDataFiltering.extract_path(path)
       slash = path[0] == "/" ? "" : "/"
       @macaw_log&.info("Defining #{prefix.upcase} endpoint at #{slash}#{path}")

data/sig/macaw_framework/macaw.rbs

@@ -2,6 +2,7 @@ module MacawFramework
   class Macaw
     @bind: String
     @cache: untyped
+    @cached_methods: Hash[String, Array[String]]
     @config: Hash[String, untyped]
     @cron_runner: CronRunner
     @endpoints_to_cache: Array[String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-18 00:00:00.000000000 Z
+date: 2024-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client