macaw_framework 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f108da6fb2654c701154a544cea00e47d9546c5092ef3dcbc1e299c34420ddd
-  data.tar.gz: 23c72078365336da0585d7ee88cce41db2972efcfcc72c930ccceb73edb302ed
+  metadata.gz: 23fe3e98800399fc740bf5a76603fab28e53502d8f5041d894ecac5bef96f00c
+  data.tar.gz: 5b8f46d645b2e274d005368e9f144bca0b63eac552942ea3176172a1479ac4a4
 SHA512:
-  metadata.gz: 9e0feab01f25bab3ce8b65799c516f04a837c5e250b8f53934049c2c3f1db303d92cfa9629151c0c8b46836e9a77690aea1a27cfc7b8bb1b99c7f9340a3cb8f1
-  data.tar.gz: cb769896b94e443248ecc419ffb69f0c587e9cda52430516204b8bcfed0a56eed5cf4aac3f6ca05f53dabe5d954777579e088c351dd82f2a61fdf47871bc143a
+  metadata.gz: 1757594571b01f8110c8b839c906a63488aa25120adc1b96f7a87066cbaea0473d0628398d9d134e4950d3b6dcf19ddd07bc806620608f2214404aee0950587e
+  data.tar.gz: 8326f4957ba9d8baa95603d5c4c4300339e6e4a4d6797fc34945e88d9e07dc9e102ac0ba5a0dbce90ea581f8ab7f5fc4e8d8f22c8cf6e0d2013863f2f634a0b2

data/CHANGELOG.md

@@ -67,3 +67,10 @@
 ## [1.0.5] - 2023-05-12
 
 - Fixing critical bug where threads were being killed and not respawning after abrupt client connection shutdown
+
+## [1.1.0] - 2023-xx-xx
+
+- Adding support for other SSL/TSL keys other than RSA
+- New mechanism to handle server shutdown properly
+- Improving log readability
+- Automatic logging is now optional

data/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing to Macaw Framework
+
+First off, thank you for considering contributing to Macaw Framework.
+
+## Getting Started
+
+- Submit an issue for your problem or suggestion, assuming one does not already exist.
+    - Clearly describe the issue including steps to reproduce when it is a bug.
+    - Make sure you fill in the earliest version that you know has the issue.
+
+## Making Changes
+
+- Fork the repository on GitHub.
+- Create a topic branch from where you want to base your work. This is usually the main branch.
+    - To quickly create a topic branch based on main; `git checkout -b fix/main/my_contribution main`. Please avoid working directly on the `main` branch.
+- Make commits of logical units.
+- Check for unnecessary whitespace with `git diff --check` before committing.
+- Make sure your commit messages are in the proper format.
+- Make sure you have added the necessary tests for your changes.
+- Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Submitting Changes
+
+- Run RuboCop to ensure your code adheres to our code style conventions. You can do this by running `rubocop` in your terminal.
+- Push your changes to a topic branch in your fork of the repository.
+- Submit a pull request to the repository in my GitHub account.
+- Our automatic CI/CD pipeline will run all tests and lint for 3 different ruby versions before merges.
+- I'm constantly reviewing Pull Requests and will provide feedback as soon as possible.
+
+Thanks for contributing!

data/README.md

@@ -108,6 +108,7 @@ end
     "ssl": {
       "min": "SSL3",
       "max": "TLS1.3",
+      "key_type": "EC",
       "cert_file_name": "path/to/cert/file/file.crt",
       "key_file_name": "path/to/cert/key/file.key"
     }
@@ -123,6 +124,12 @@ curl http://localhost:8080/metrics
 
 ### Tips
 
+The automatic logging and log aspect are now optional. To disable them, simply start Macaw with `custom_log` set to nil.
+
+```ruby
+MacawFramework::Macaw.new(custom_log: nil)
+```
+
 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. It is possible to
 provide a list of strings in the property `ignore_headers`. All the client headers with the same name of any
@@ -143,7 +150,8 @@ exists inside `application.json`.
 If the SSL configuration is provided in the `application.json` file with valid certificate and key files, the TCP server
 will be wrapped with HTTPS security using the provided certificate.
 
-The supported values for `min` and `max` in the SSL configuration are: `SSL2`, `SSL3`, `TLS1.1`, `TLS1.2` and `TLS1.3`
+The supported values for `min` and `max` in the SSL configuration are: `SSL2`, `SSL3`, `TLS1.1`, `TLS1.2` and `TLS1.3`,
+and the supported values for `key_type` are `RSA` and `EC`.
 
 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.

data/lib/macaw_framework/aspects/logging_aspect.rb

@@ -9,6 +9,8 @@ require_relative "../data_filters/log_data_filter"
 # in the framework.
 module LoggingAspect
   def call_endpoint(logger, *args)
+    return super(*args) if logger.nil?
+
     endpoint_name = args[1].split(".")[1..].join("/")
     logger.info(LogDataFilter.sanitize_for_logging(
                   "Request received for #{endpoint_name} with arguments: #{args[2..]}"

data/lib/macaw_framework/core/server.rb

@@ -70,7 +70,7 @@ class Server
     loop do
       @work_queue << @server.accept
     rescue OpenSSL::SSL::SSLError => e
-      @macaw_log.error("SSL error: #{e.message}")
+      @macaw_log&.error("SSL error: #{e.message}")
     rescue IOError, Errno::EBADF
       break
     end
@@ -79,9 +79,7 @@ class Server
   ##
   # Method Responsible for closing the TCP server.
   def close
-    @server.close
-    @num_threads.times { @work_queue << :shutdown }
-    @workers.each(&:join)
+    shutdown
   end
 
   private
@@ -94,7 +92,7 @@ class Server
     declare_client_session(client)
     client_data = get_client_data(body, headers, parameters)
 
-    @macaw_log.info("Running #{path.gsub("\n", "").gsub("\r", "")}")
+    @macaw_log&.info("Running #{path.gsub("\n", "").gsub("\r", "")}")
     message, status, response_headers = call_endpoint(@prometheus_middleware, @macaw_log, @cache,
                                                       method_name, client_data, client.peeraddr[3])
     status ||= 200
@@ -102,19 +100,19 @@ class Server
     response_headers ||= nil
     client.puts ResponseDataFilter.mount_response(status, response_headers, message)
   rescue IOError, Errno::EPIPE => e
-    @macaw_log.error("Error writing to client: #{e.message}")
+    @macaw_log&.error("Error writing to client: #{e.message}")
   rescue TooManyRequestsError
     client.print "HTTP/1.1 429 Too Many Requests\r\n\r\n"
   rescue EndpointNotMappedError
     client.print "HTTP/1.1 404 Not Found\r\n\r\n"
   rescue StandardError => e
     client.print "HTTP/1.1 500 Internal Server Error\r\n\r\n"
-    @macaw_log.info("Error: #{e}")
+    @macaw_log&.info("Error: #{e}")
   ensure
     begin
       client.close
     rescue IOError => e
-      @macaw_log.error("Error closing client: #{e.message}")
+      @macaw_log&.error("Error closing client: #{e.message}")
     end
   end
 
@@ -147,13 +145,20 @@ class Server
       @context.min_version = SupportedSSLVersions::VERSIONS[version_config[:min]] unless version_config[:min].nil?
       @context.max_version = SupportedSSLVersions::VERSIONS[version_config[:max]] unless version_config[:max].nil?
       @context.cert = OpenSSL::X509::Certificate.new(File.read(ssl_config["cert_file_name"]))
-      @context.key = OpenSSL::PKey::RSA.new(File.read(ssl_config["key_file_name"]))
+
+      if ssl_config["key_type"] == "RSA" || ssl_config["key_type"].nil?
+        @context.key = OpenSSL::PKey::RSA.new(File.read(ssl_config["key_file_name"]))
+      elsif ssl_config["key_type"] == "EC"
+        @context.key = OpenSSL::PKey::EC.new(File.read(ssl_config["key_file_name"]))
+      else
+        raise ArgumentError, "Unsupported SSL/TLS key type: #{ssl_config["key_type"]}"
+      end
     end
     @context ||= nil
   rescue IOError => e
-    @macaw_log.error("It was not possible to read files #{@macaw.config["macaw"]["ssl"]["cert_file_name"]} and
-#{@macaw.config["macaw"]["ssl"]["key_file_name"]}. Please assure the files exists and their names are correct.")
-    @macaw_log.error(e.backtrace)
+    @macaw_log&.error("It was not possible to read files #{@macaw.config["macaw"]["ssl"]["cert_file_name"]} and
+#{@macaw.config["macaw"]["ssl"]["key_file_name"]}. Please assure the files exist and their names are correct.")
+    @macaw_log&.error(e.backtrace)
     raise e
   end
 
@@ -168,6 +173,7 @@ class Server
   end
 
   def set_features
+    @is_shutting_down = false
     set_rate_limiting
     set_session
     set_ssl
@@ -206,10 +212,27 @@ class Server
     @workers_mutex.synchronize do
       @workers.each_with_index do |worker, index|
         unless worker.alive?
-          @macaw_log.error("Worker thread #{index} died, respawning...")
-          @workers[index] = spawn_worker
+          if @is_shutting_down
+            @macaw_log&.info("Worker thread #{index} finished, not respawning due to server shutdown.")
+          else
+            @macaw_log&.error("Worker thread #{index} died, respawning...")
+            @workers[index] = spawn_worker
+          end
         end
       end
     end
   end
+
+  def shutdown
+    @is_shutting_down = true
+    loop do
+      break if @work_queue.empty?
+
+      sleep 0.1
+    end
+
+    @num_threads.times { @work_queue << :shutdown }
+    @workers.each(&:join)
+    @server.close
+  end
 end

data/lib/macaw_framework/data_filters/log_data_filter.rb

@@ -36,6 +36,7 @@ module LogDataFilter
     data = data.to_s.force_encoding("UTF-8")
     data = data.gsub(/[\x00-\x1F\x7F]/, "")
     data = data.gsub(/\s+/, " ")
+    data = data.gsub("/", "")
     data = data.slice(0, config[:max_length])
 
     sensitive_fields.each do |field|

data/lib/macaw_framework/version.rb

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

data/lib/macaw_framework.rb

@@ -22,10 +22,10 @@ module MacawFramework
 
     ##
     # @param {Logger} custom_log
-    def initialize(custom_log: nil, server: Server)
+    def initialize(custom_log: Logger.new($stdout), server: Server)
       begin
         @routes = []
-        @macaw_log ||= custom_log.nil? ? Logger.new($stdout) : custom_log
+        @macaw_log ||= custom_log
         @config = JSON.parse(File.read("application.json"))
         @port = @config["macaw"]["port"] || 8080
         @bind = @config["macaw"]["bind"] || "localhost"
@@ -37,7 +37,7 @@ module MacawFramework
         @prometheus_middleware = PrometheusMiddleware.new if @config["macaw"]["prometheus"]
         @prometheus_middleware.configure_prometheus(@prometheus, @config, self) if @config["macaw"]["prometheus"]
       rescue StandardError => e
-        @macaw_log.warn(e.message)
+        @macaw_log&.warn(e.message)
       end
       @port ||= 8080
       @bind ||= "localhost"
@@ -103,15 +103,28 @@ module MacawFramework
     ##
     # Starts the web server
     def start!
-      @macaw_log.info("---------------------------------")
-      @macaw_log.info("Starting server at port #{@port}")
-      @macaw_log.info("Number of threads: #{@threads}")
-      @macaw_log.info("---------------------------------")
+      if @macaw_log.nil?
+        puts("---------------------------------")
+        puts("Starting server at port #{@port}")
+        puts("Number of threads: #{@threads}")
+        puts("---------------------------------")
+      else
+        @macaw_log.info("---------------------------------")
+        @macaw_log.info("Starting server at port #{@port}")
+        @macaw_log.info("Number of threads: #{@threads}")
+        @macaw_log.info("---------------------------------")
+      end
       server_loop(@server)
     rescue Interrupt
-      @macaw_log.info("Stopping server")
-      @server.close
-      @macaw_log.info("Macaw stop flying for some seeds...")
+      if @macaw_log.nil?
+        puts("Stopping server")
+        @server.close
+        puts("Macaw stop flying for some seeds...")
+      else
+        @macaw_log.info("Stopping server")
+        @server.close
+        @macaw_log.info("Macaw stop flying for some seeds...")
+      end
     end
 
     private
@@ -123,7 +136,7 @@ module MacawFramework
     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}")
+      @macaw_log&.info("Defining #{prefix.upcase} endpoint at /#{path}")
       define_singleton_method("#{prefix}.#{path_clean}", block || lambda {
         |context = { headers: {}, body: "", params: {} }|
                                                          })

data/sig/macaw_framework/macaw.rbs

@@ -4,7 +4,7 @@ module MacawFramework
     @cache: untyped
     @config: Hash[String, untyped]
     @endpoints_to_cache: Array[String]
-    @macaw_log: Logger
+    @macaw_log: Logger?
 
     @prometheus: untyped
     @prometheus_middleware: untyped
@@ -14,7 +14,7 @@ module MacawFramework
 
     attr_reader bind: String
     attr_reader config: Hash[String, untyped]
-    attr_reader macaw_log: Logger
+    attr_reader macaw_log: Logger?
     attr_reader port: Integer
     attr_reader routes: Array[String]
 

data/sig/server.rbs

@@ -4,7 +4,7 @@ class Server
   @context: OpenSSL::SSL::SSLContext
   @endpoints_to_cache: Array[String]
   @macaw: MacawFramework::Macaw
-  @macaw_log: Logger
+  @macaw_log: Logger?
   @num_threads: Integer
   @port: Integer
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -36,6 +36,7 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md