macaw_framework 1.2.4 → 1.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +2 -6
- data/lib/macaw_framework/aspects/cache_aspect.rb +5 -4
- data/lib/macaw_framework/core/common/server_base.rb +0 -6
- data/lib/macaw_framework/core/thread_server.rb +5 -3
- data/lib/macaw_framework/version.rb +1 -1
- data/lib/macaw_framework.rb +12 -9
- data/sig/macaw_framework/macaw.rbs +1 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fd7f1b0bfc6306d0d86f2228f3a51cf955cad0db12031920cf9f0f131d664f6d
|
4
|
+
data.tar.gz: 92ea7a2854218fb31726c37bc6cbe99399159cdb0cc08a3c72ce62e4b27e72c2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1a06342e79d24109aa1b47058e7a973009e9e19a0a898f95c653a13dd3558b5576be34b628f5fbf488aa0b019f35ed6f941fd1b3808c7894bac9dd1b9d9c85e5
|
7
|
+
data.tar.gz: cfff2868edfd0314006a36cdeb21d1f69ed6388b2c9a5181cec7f67c1c101818f6feb58e865d3672c84b55c3d71372a3850e9dd6b0ee6f3f948baec5af2a726c
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -104,7 +104,7 @@ m.start!
|
|
104
104
|
### Caching: Improve performance by caching responses and configuring cache invalidation
|
105
105
|
|
106
106
|
```ruby
|
107
|
-
m.get('/cached_data', cache:
|
107
|
+
m.get('/cached_data', cache: ["header_to_cache", "query_param_to_cache"]) do |context|
|
108
108
|
# Retrieve data
|
109
109
|
end
|
110
110
|
```
|
@@ -140,11 +140,7 @@ end
|
|
140
140
|
"bind": "localhost",
|
141
141
|
"threads": 200,
|
142
142
|
"cache": {
|
143
|
-
"cache_invalidation": 3600
|
144
|
-
"ignore_headers": [
|
145
|
-
"header-to-be-ignored-from-caching-strategy",
|
146
|
-
"another-header-to-be-ignored-from-caching-strategy"
|
147
|
-
]
|
143
|
+
"cache_invalidation": 3600
|
148
144
|
},
|
149
145
|
"prometheus": {
|
150
146
|
"endpoint": "/metrics"
|
@@ -6,7 +6,7 @@ module CacheAspect
|
|
6
6
|
def call_endpoint(cache, *args)
|
7
7
|
return super(*args) unless !cache[:cache].nil? && cache[:endpoints_to_cache]&.include?(args[0])
|
8
8
|
|
9
|
-
cache_filtered_name = cache_name_filter(args[1], cache[:
|
9
|
+
cache_filtered_name = cache_name_filter(args[1], cache[:cached_methods][args[0]])
|
10
10
|
|
11
11
|
cache[:cache].mutex.synchronize do
|
12
12
|
return cache[:cache].cache[cache_filtered_name][0] unless cache[:cache].cache[cache_filtered_name].nil?
|
@@ -19,9 +19,10 @@ module CacheAspect
|
|
19
19
|
|
20
20
|
private
|
21
21
|
|
22
|
-
def cache_name_filter(client_data,
|
23
|
-
filtered_headers = client_data[:headers]
|
24
|
-
|
22
|
+
def cache_name_filter(client_data, cached_methods_params)
|
23
|
+
filtered_headers = client_data[:headers]&.filter { |key, _value| cached_methods_params&.include?(key) }
|
24
|
+
filtered_params = client_data[:params]&.filter { |key, _value| cached_methods_params&.include?(key) }
|
25
|
+
[{ params: filtered_params, headers: filtered_headers }].to_s.to_sym
|
25
26
|
end
|
26
27
|
|
27
28
|
def should_cache_response?(status)
|
@@ -83,12 +83,6 @@ module ServerBase
|
|
83
83
|
)
|
84
84
|
end
|
85
85
|
|
86
|
-
def set_cache_ignored_h
|
87
|
-
return unless @macaw.config&.dig("macaw", "cache", "ignore_headers")
|
88
|
-
|
89
|
-
@macaw.config["macaw"]["cache"]["ignore_headers"] || []
|
90
|
-
end
|
91
|
-
|
92
86
|
def set_ssl
|
93
87
|
ssl_config = @macaw.config["macaw"]["ssl"] if @macaw.config&.dig("macaw", "ssl")
|
94
88
|
ssl_config ||= nil
|
@@ -32,11 +32,13 @@ class ThreadServer
|
|
32
32
|
@macaw_log = macaw.macaw_log
|
33
33
|
@num_threads = macaw.threads
|
34
34
|
@work_queue = Queue.new
|
35
|
-
ignored_headers = set_cache_ignored_h
|
36
35
|
set_features
|
37
36
|
@rate_limit ||= nil
|
38
|
-
|
39
|
-
|
37
|
+
@cache = {
|
38
|
+
cache: cache,
|
39
|
+
endpoints_to_cache: endpoints_to_cache || [],
|
40
|
+
cached_methods: macaw.cached_methods
|
41
|
+
}
|
40
42
|
@prometheus = prometheus
|
41
43
|
@prometheus_middleware = prometheus_mw
|
42
44
|
@workers = []
|
data/lib/macaw_framework.rb
CHANGED
@@ -19,16 +19,18 @@ module MacawFramework
|
|
19
19
|
# Class responsible for creating endpoints and
|
20
20
|
# starting the web server.
|
21
21
|
class Macaw
|
22
|
-
|
23
|
-
# Array containing the routes defined in the application
|
24
|
-
attr_reader :routes, :macaw_log, :config, :jobs
|
22
|
+
attr_reader :routes, :macaw_log, :config, :jobs, :cached_methods
|
25
23
|
attr_accessor :port, :bind, :threads
|
26
24
|
|
27
25
|
##
|
26
|
+
# Initialize Macaw Class
|
28
27
|
# @param {Logger} custom_log
|
28
|
+
# @param {ThreadServer} server
|
29
|
+
# @param {String?} dir
|
29
30
|
def initialize(custom_log: Logger.new($stdout), server: ThreadServer, dir: nil)
|
30
31
|
begin
|
31
32
|
@routes = []
|
33
|
+
@cached_methods = {}
|
32
34
|
@macaw_log ||= custom_log
|
33
35
|
@config = JSON.parse(File.read("application.json"))
|
34
36
|
@port = @config["macaw"]["port"] || 8080
|
@@ -65,7 +67,7 @@ module MacawFramework
|
|
65
67
|
# macaw.get("/hello") do |context|
|
66
68
|
# return "Hello World!", 200, { "Content-Type" => "text/plain" }
|
67
69
|
# end
|
68
|
-
def get(path, cache:
|
70
|
+
def get(path, cache: [], &block)
|
69
71
|
map_new_endpoint("get", cache, path, &block)
|
70
72
|
end
|
71
73
|
|
@@ -81,7 +83,7 @@ module MacawFramework
|
|
81
83
|
# macaw.post("/hello") do |context|
|
82
84
|
# return "Hello World!", 200, { "Content-Type" => "text/plain" }
|
83
85
|
# end
|
84
|
-
def post(path, cache:
|
86
|
+
def post(path, cache: [], &block)
|
85
87
|
map_new_endpoint("post", cache, path, &block)
|
86
88
|
end
|
87
89
|
|
@@ -96,7 +98,7 @@ module MacawFramework
|
|
96
98
|
# macaw.put("/hello") do |context|
|
97
99
|
# return "Hello World!", 200, { "Content-Type" => "text/plain" }
|
98
100
|
# end
|
99
|
-
def put(path, cache:
|
101
|
+
def put(path, cache: [], &block)
|
100
102
|
map_new_endpoint("put", cache, path, &block)
|
101
103
|
end
|
102
104
|
|
@@ -111,7 +113,7 @@ module MacawFramework
|
|
111
113
|
# macaw.patch("/hello") do |context|
|
112
114
|
# return "Hello World!", 200, { "Content-Type" => "text/plain" }
|
113
115
|
# end
|
114
|
-
def patch(path, cache:
|
116
|
+
def patch(path, cache: [], &block)
|
115
117
|
map_new_endpoint("patch", cache, path, &block)
|
116
118
|
end
|
117
119
|
|
@@ -126,7 +128,7 @@ module MacawFramework
|
|
126
128
|
# macaw.delete("/hello") do |context|
|
127
129
|
# return "Hello World!", 200, { "Content-Type" => "text/plain" }
|
128
130
|
# end
|
129
|
-
def delete(path, cache:
|
131
|
+
def delete(path, cache: [], &block)
|
130
132
|
map_new_endpoint("delete", cache, path, &block)
|
131
133
|
end
|
132
134
|
|
@@ -196,7 +198,8 @@ module MacawFramework
|
|
196
198
|
end
|
197
199
|
|
198
200
|
def map_new_endpoint(prefix, cache, path, &block)
|
199
|
-
@endpoints_to_cache << "#{prefix}.#{RequestDataFiltering.sanitize_method_name(path)}"
|
201
|
+
@endpoints_to_cache << "#{prefix}.#{RequestDataFiltering.sanitize_method_name(path)}" unless cache.empty?
|
202
|
+
@cached_methods["#{prefix}.#{RequestDataFiltering.sanitize_method_name(path)}"] = cache unless cache.empty?
|
200
203
|
path_clean = RequestDataFiltering.extract_path(path)
|
201
204
|
slash = path[0] == "/" ? "" : "/"
|
202
205
|
@macaw_log&.info("Defining #{prefix.upcase} endpoint at #{slash}#{path}")
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: macaw_framework
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.2.
|
4
|
+
version: 1.2.5
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Aria Diniz
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-04-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: prometheus-client
|