macaw_framework 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d900a18480da4792dfa03608ca8c85c0d0ba4084a3430c39008f4ca026ae784c
-  data.tar.gz: e3bc35f7b78bc0a6e995c0abd906879dda434e4c12306d3d55713c35dc45065c
+  metadata.gz: b2191d627ee06b38338eeef5d88e16791ad96c9ac94fd3b4f8a917cb7a4fd1d6
+  data.tar.gz: 8572db3e03300d28013c29f2bc5238d2f2a4907b087cfc1fe60ff6a8b2369026
 SHA512:
-  metadata.gz: 6ac4eb646bb2510fbc67ddec9ccfca45bea8dfcb6833f9e55b60f0f18d5edebaf392645c53dae7745eec797c926af1700c273516682bd6f10e66c2b018f1cea6
-  data.tar.gz: 0ecb2e16a9f1762833751bb403d824e04571c4f3b79f01355ffb6f1f29eb29c234befc759c7d76d7b939f05d5f9f3c252d8a5828198e9c7674b7854fe2edcdf1
+  metadata.gz: 58cc6a8c9fe40d4f2fead09cf8188ac440dce1444b387a737283285ba1d823b9604ada962305d7c9279bfe0195215b891ecf417715dc755f1b027f75ffa07c13
+  data.tar.gz: 6e8b48c28f83a5eb33f5166c37dc1bbacc2831a3fd31f494e75a5ded27410d006475f12b684da06051b4a6ffe27a3067b1c8dfd5ab0acdaf12ecaba8b444ca60

data/.rubocop.yml

@@ -16,7 +16,13 @@ Metrics/MethodLength:
   Max: 30
 
 Metrics/AbcSize:
-  Max: 35
+  Enabled: false
 
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 15
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/CHANGELOG.md

@@ -24,3 +24,13 @@
 - Adding log by aspect on endpoint calls to improve observability
 - Moving the server for a new separate class to respect single responsibility
 - Improved the data filtering middleware to sanitize inputs
+
+## [0.1.5] - 2023-04-16
+
+- Adding support to path variables
+
+## [0.2.0] - 2023-04-22
+
+- Adding middleware for integration with Prometheus to collect metrics
+- Adding a simple caching mechanism that can be enabled separately for each endpoint
+- Performance and functional optimizations

data/Gemfile

@@ -12,3 +12,5 @@ gem "minitest", "~> 5.0"
 gem "rubocop", "~> 1.21"
 
 gem "simplecov", "~> 0.22.0"
+
+gem "prometheus-client", "~> 4.1"

data/README.md

@@ -3,7 +3,7 @@
 <img src="macaw_logo.png" alt= “” style="width: 30%;height: 30%;margin-left: 35%">
 
 This is a framework for developing web applications. Please have in mind that this is still a work in progress and
-it is strongly advised to not use it for production purposes for now. Actualy it supports only HTTP. HTTPS and SSL
+it is strongly advised to not use it for production purposes for now. Actually it supports only HTTP. and HTTPS/SSL
 support will be implemented soon. Anyone who wishes to contribute is welcome.
 
 ## Installation
@@ -19,7 +19,6 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 The usage of the framework still very simple. Actually it support 5 HTTP verbs: GET, POST, PUT, PATCH and DELETE.
-For now, the framework can't resolve client request body and headers. The support for this will be included soon.
 
 The default server port is 8080. To choose a different port, create a file with the name `application.json` 
 in the same directory of the script that will start the application with the following content:
@@ -29,11 +28,17 @@ in the same directory of the script that will start the application with the fol
   "macaw": {
     "port": 8080,
     "bind": "localhost",
-    "threads": 10
+    "threads": 10,
+    "cache": {
+      "cache_invalidation": 3600
+    }
   }
 }
 ```
 
+Cache invalidation time should be specified in seconds. In order to enable caching, The application.json file
+should exist in the app main directory and it need the `cache_invalidation` config set.
+
 Example of usage:
 
 ```ruby
@@ -42,20 +47,32 @@ require 'json'
 
 m = MacawFramework::Macaw.new
 
-m.get('/hello_world') do |context|
+m.get('/hello_world', cache: true) do |context|
+  context[:body] # Returns the request body as string
+  context[:params] # Returns query parameters and path variables as a hash
+  context[:headers] # Returns headers as a hash
+  return JSON.pretty_generate({ hello_message: 'Hello World!' }), 200
+end
+
+m.post('/hello_world/:path_variable') do |context|
   context[:body] # Returns the request body as string
   context[:params] # Returns query parameters and path variables as a hash
   context[:headers] # Returns headers as a hash
+  context[:params][:path_variable] # The defined path variable can be found in :params
   return JSON.pretty_generate({ hello_message: 'Hello World!' }), 200
 end
 
 m.start!
 ```
 
-The above example will start a server and will create a GET endpoint at localhost/hello_world.
+The example above starts a server and creates a GET endpoint at localhost/hello_world.
+
+If prometheus is enabled, a get endpoint will be defined at path `/metrics` to collect prometheus metrics. This path
+is configurable via the `application.json` file.
 
-The verb methods must always return a String or nil (Used as response) and a number corresponding the 
-HTTP Status Code to be returned to the client.
+The verb methods must always return a string or nil (used as the response) and a number corresponding to the HTTP status 
+code to be returned to the client. If an endpoint doesn't return a value or returns nil for both the string and the 
+code, a default 200 OK status will be sent as the response.
 
 ## Contributing
 

data/lib/macaw_framework/aspects/cache_aspect.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+##
+# Aspect that provide cache for the endpoints.
+module CacheAspect
+  def call_endpoint(cache, endpoints_to_cache, *args)
+    return super(*args) unless endpoints_to_cache.include?(args[0]) && !cache.nil?
+    return cache.cache[args[2..].to_s.to_sym][0] unless cache.cache[args[2..].to_s.to_sym].nil?
+
+    response = super(*args)
+    cache.cache[args[2..].to_s.to_sym] = [response, Time.now]
+    response
+  end
+end

data/lib/macaw_framework/aspects/logging_aspect.rb

@@ -8,9 +8,17 @@ require "logger"
 # in the framework.
 module LoggingAspect
   def call_endpoint(logger, *args)
-    logger.info("Input of #{args[0]}: #{args}")
-    response = super(*args)
-    logger.info("Output of #{args[0]} #{response}")
+    endpoint_name = args[2].split(".")[1..].join("/")
+    logger.info("Request received for #{endpoint_name} with arguments: #{args[3..]}")
+
+    begin
+      response = super(*args)
+      logger.info("Response for #{endpoint_name}: #{response}")
+    rescue StandardError => e
+      logger.error("Error processing #{endpoint_name}: #{e.message}\n#{e.backtrace.join("\n")}")
+      raise e
+    end
+
     response
   end
 end

data/lib/macaw_framework/aspects/prometheus_aspect.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+##
+# Aspect that provides application metrics using prometheus.
+module PrometheusAspect
+  def call_endpoint(prometheus_middleware, *args)
+    return super(*args) if prometheus_middleware.nil?
+
+    start_time = Time.now
+
+    begin
+      response = super(*args)
+    ensure
+      duration = (Time.now - start_time) * 1_000
+
+      endpoint_name = args[3].split(".").join("/")
+
+      prometheus_middleware.request_duration_milliseconds.with_labels(endpoint: endpoint_name).observe(duration)
+      prometheus_middleware.request_count.with_labels(endpoint: endpoint_name).increment
+      if response
+        prometheus_middleware.response_count.with_labels(endpoint: endpoint_name,
+                                                         status: response[1]).increment
+      end
+    end
+
+    response
+  end
+end

data/lib/macaw_framework/{middlewares → core}/server.rb

@@ -1,14 +1,19 @@
 # frozen_string_literal: true
 
+require_relative "../aspects/prometheus_aspect"
 require_relative "../aspects/logging_aspect"
 require_relative "../utils/http_status_code"
+require_relative "../aspects/cache_aspect"
 
 ##
 # Class responsible for providing a default
 # webserver.
 class Server
+  prepend CacheAspect
   prepend LoggingAspect
+  prepend PrometheusAspect
   include HttpStatusCode
+  # rubocop:disable Metrics/ParameterLists
 
   ##
   # Create a new instance of Server.
@@ -17,17 +22,26 @@ class Server
   # @param {Integer} port
   # @param {String} bind
   # @param {Integer} num_threads
+  # @param {CachingMiddleware} cache
+  # @param {Prometheus::Client:Registry} prometheus
   # @return {Server}
-  def initialize(macaw, logger, port, bind, num_threads)
+  def initialize(macaw, logger, port, bind, num_threads, endpoints_to_cache = nil, cache = nil, prometheus = nil,
+                 prometheus_middleware = nil)
     @port = port
     @bind = bind
     @macaw = macaw
     @macaw_log = logger
     @num_threads = num_threads
     @work_queue = Queue.new
+    @endpoints_to_cache = endpoints_to_cache || []
+    @cache = cache
+    @prometheus = prometheus
+    @prometheus_middleware = prometheus_middleware
     @workers = []
   end
 
+  # rubocop:enable Metrics/ParameterLists
+
   ##
   # Start running the webserver.
   def run
@@ -65,17 +79,17 @@ class Server
     raise EndpointNotMappedError unless @macaw.respond_to?(method_name)
 
     @macaw_log.info("Running #{path.gsub("\n", "").gsub("\r", "")}")
-    message, status = call_endpoint(@macaw_log, method_name, headers, body, parameters)
+    message, status = call_endpoint(@prometheus_middleware, @macaw_log, @cache, @endpoints_to_cache,
+                                    method_name, headers, body, parameters)
     status ||= 200
-    message ||= "Ok"
+    message ||= nil
     client.puts "HTTP/1.1 #{status} #{HTTP_STATUS_CODE_MAP[status]} \r\n\r\n#{message}"
-    client.close
   rescue EndpointNotMappedError
     client.print "HTTP/1.1 404 Not Found\r\n\r\n"
-    client.close
   rescue StandardError => e
     client.print "HTTP/1.1 500 Internal Server Error\r\n\r\n"
     @macaw_log.info("Error: #{e}")
+  ensure
     client.close
   end
 

data/lib/macaw_framework/middlewares/caching_middleware.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+##
+# Middleware responsible for storing and
+# invalidating cache.
+class CachingMiddleware
+  attr_accessor :cache
+
+  def initialize(inv_time_seconds = 3_600)
+    @cache = {}
+    Thread.new do
+      loop do
+        sleep(1)
+        @cache.each_pair do |key, value|
+          @cache.delete(key) if Time.now - value[1] >= inv_time_seconds
+        end
+      end
+    end
+    sleep(2)
+  end
+end

data/lib/macaw_framework/middlewares/prometheus_middleware.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "prometheus/client"
+require "prometheus/client/formats/text"
+
+##
+# Middleware responsible to configure prometheus
+# defining metrics and an endpoint to access them.
+class PrometheusMiddleware
+  attr_accessor :request_duration_milliseconds, :request_count, :response_count
+
+  def configure_prometheus(prometheus_registry, configurations, macaw)
+    return nil unless prometheus_registry
+
+    @request_duration_milliseconds = Prometheus::Client::Histogram.new(
+      :request_duration_milliseconds,
+      docstring: "The duration of each request in milliseconds",
+      labels: [:endpoint],
+      buckets: (100..1000).step(100).to_a + (2000..10_000).step(1000).to_a
+    )
+
+    @request_count = Prometheus::Client::Counter.new(
+      :request_count,
+      docstring: "The total number of requests received",
+      labels: [:endpoint]
+    )
+
+    @response_count = Prometheus::Client::Counter.new(
+      :response_count,
+      docstring: "The total number of responses sent",
+      labels: %i[endpoint status]
+    )
+
+    prometheus_registry.register(@request_duration_milliseconds)
+    prometheus_registry.register(@request_count)
+    prometheus_registry.register(@response_count)
+    prometheus_endpoint(prometheus_registry, configurations, macaw)
+  end
+
+  private
+
+  def prometheus_endpoint(prometheus_registry, configurations, macaw)
+    endpoint = configurations["macaw"]["prometheus"]["endpoint"] || "/metrics"
+    macaw.get(endpoint) do |_context|
+      [Prometheus::Client::Formats::Text.marshal(prometheus_registry), 200]
+    end
+  end
+end

data/lib/macaw_framework/version.rb

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

data/lib/macaw_framework.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require_relative "macaw_framework/errors/endpoint_not_mapped_error"
+require_relative "macaw_framework/middlewares/prometheus_middleware"
 require_relative "macaw_framework/middlewares/request_data_filtering"
-require_relative "macaw_framework/middlewares/server"
+require_relative "macaw_framework/middlewares/caching_middleware"
+require_relative "macaw_framework/core/server"
 require_relative "macaw_framework/version"
+require "prometheus/client"
 require "logger"
 require "socket"
 require "json"
@@ -24,16 +27,26 @@ module MacawFramework
         @routes = []
         @macaw_log ||= custom_log.nil? ? Logger.new($stdout) : custom_log
         config = JSON.parse(File.read("application.json"))
-        @port = config["macaw"]["port"]
-        @bind = config["macaw"]["bind"]
-        @threads = config["macaw"]["threads"].to_i
+        @port = config["macaw"]["port"] || 8080
+        @bind = config["macaw"]["bind"] || "localhost"
+        @threads = config["macaw"]["threads"] || 5
+        unless config["macaw"]["cache"].nil?
+          @cache = CachingMiddleware.new(config["macaw"]["cache"]["cache_invalidation"].to_i || 3_600)
+        end
+        @prometheus = Prometheus::Client::Registry.new if config["macaw"]["prometheus"]
+        @prometheus_middleware = PrometheusMiddleware.new if config["macaw"]["prometheus"]
+        @prometheus_middleware.configure_prometheus(@prometheus, config, self) if config["macaw"]["prometheus"]
       rescue StandardError => e
         @macaw_log.error(e.message)
       end
       @port ||= 8080
       @bind ||= "localhost"
       @threads ||= 5
-      @server = server.new(self, @macaw_log, @port, @bind, @threads)
+      @endpoints_to_cache = []
+      @prometheus ||= nil
+      @prometheus_middleware ||= nil
+      @server = server.new(self, @macaw_log, @port, @bind, @threads, @endpoints_to_cache, @cache, @prometheus,
+                           @prometheus_middleware)
     end
 
     ##
@@ -42,18 +55,19 @@ module MacawFramework
     # @param {String} path
     # @param {Proc} block
     # @return {Integer, String}
-    def get(path, &block)
-      map_new_endpoint("get", path, &block)
+    def get(path, cache: false, &block)
+      map_new_endpoint("get", cache, path, &block)
     end
 
     ##
     # Creates a POST endpoint associated
     # with the respective path.
     # @param {String} path
+    # @param {Boolean} cache
     # @param {Proc} block
     # @return {String, Integer}
-    def post(path, &block)
-      map_new_endpoint("post", path, &block)
+    def post(path, cache: false, &block)
+      map_new_endpoint("post", cache, path, &block)
     end
 
     ##
@@ -62,8 +76,8 @@ module MacawFramework
     # @param {String} path
     # @param {Proc} block
     # @return {String, Integer}
-    def put(path, &block)
-      map_new_endpoint("put", path, &block)
+    def put(path, cache: false, &block)
+      map_new_endpoint("put", cache, path, &block)
     end
 
     ##
@@ -72,8 +86,8 @@ module MacawFramework
     # @param {String} path
     # @param {Proc} block
     # @return {String, Integer}
-    def patch(path, &block)
-      map_new_endpoint("patch", path, &block)
+    def patch(path, cache: false, &block)
+      map_new_endpoint("patch", cache, path, &block)
     end
 
     ##
@@ -82,8 +96,8 @@ module MacawFramework
     # @param {String} path
     # @param {Proc} block
     # @return {String, Integer}
-    def delete(path, &block)
-      map_new_endpoint("delete", path, &block)
+    def delete(path, cache: false, &block)
+      map_new_endpoint("delete", cache, path, &block)
     end
 
     ##
@@ -106,7 +120,8 @@ module MacawFramework
       server.run
     end
 
-    def map_new_endpoint(prefix, path, &block)
+    def map_new_endpoint(prefix, cache, path, &block)
+      @endpoints_to_cache << "#{prefix}.#{RequestDataFiltering.sanitize_method_name(path)}" if cache
       path_clean = RequestDataFiltering.extract_path(path)
       @macaw_log.info("Defining #{prefix.upcase} endpoint at /#{path}")
       define_singleton_method("#{prefix}.#{path_clean}", block || lambda {

data/sig/caching_middleware.rbs

@@ -0,0 +1,5 @@
+class CachingMiddleware
+  @cache: Hash[String, Array[string]]
+
+  attr_accessor cache: Hash[String, Array[string]]
+end

data/sig/macaw_framework/macaw.rbs

@@ -1,9 +1,12 @@
 module MacawFramework
   class Macaw
     @bind: string
+    @cache: untyped
+    @endpoints_to_cache: Array[String]
     @macaw_log: Logger
     @port: int
 
+    @prometheus: untyped
     @server: Server
 
     @threads: Integer

data/sig/server.rbs

@@ -1,10 +1,14 @@
 class Server
   @bind: String
+  @cache: CachingMiddleware
+  @endpoints_to_cache: Array[String]
   @macaw: MacawFramework::Macaw
   @macaw_log: Logger
   @num_threads: Integer
   @port: Integer
 
+  @prometheus: untyped
+  @prometheus_middleware: untyped
   @server: TCPServer
 
   @threads: Integer

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-16 00:00:00.000000000 Z
-dependencies: []
+date: 2023-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 description: A project started for study purpose that I intend to keep working on.
 email:
 - aria.diniz.dev@gmail.com
@@ -25,13 +39,18 @@ files:
 - README.md
 - Rakefile
 - lib/macaw_framework.rb
+- lib/macaw_framework/aspects/cache_aspect.rb
 - lib/macaw_framework/aspects/logging_aspect.rb
+- lib/macaw_framework/aspects/prometheus_aspect.rb
+- lib/macaw_framework/core/server.rb
 - lib/macaw_framework/errors/endpoint_not_mapped_error.rb
+- lib/macaw_framework/middlewares/caching_middleware.rb
+- lib/macaw_framework/middlewares/prometheus_middleware.rb
 - lib/macaw_framework/middlewares/request_data_filtering.rb
-- lib/macaw_framework/middlewares/server.rb
 - lib/macaw_framework/utils/http_status_code.rb
 - lib/macaw_framework/version.rb
 - macaw_logo.png
+- sig/caching_middleware.rbs
 - sig/http_status_code.rbs
 - sig/logging_aspect.rbs
 - sig/macaw_framework.rbs